# Residential 배송 상태

`GET /account/api/v1/residential/orders/status`

## 권한 인증

`Authorization: Bearer YOUR_ARNPROXY_API_KEY`

`Accept: application/json`

필요한 권한: `read`

`Idempotency-Key` · 문자, 숫자, _ 또는 -로 16~100자. 같은 작업에는 저장한 동일 값을 사용하세요.

## 매개변수

| 이름 | 유형 | 필수 / 조건부 | 기본값 | 설명 |
|---|---|---|---|---|
| `Idempotency-Key` (header) | string | 필수 | — | 문자/숫자/_/- 16~100자. 작업과 상태 조회에 같은 값을 사용하고 다른 본문에 재사용하지 마세요. |

## 요청 예제

### curl

```curl
printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    --header 'Idempotency-Key: YOUR_SAVED_OPERATION_KEY' \
    'https://www.arnproxy.com/account/api/v1/residential/orders/status'
```

### python

```python
import os, requests

headers = {"Authorization": "Bearer " + os.environ["ARNPROXY_API_KEY"]}
headers["Idempotency-Key"] = "YOUR_SAVED_OPERATION_KEY"
response = requests.get(
    "https://www.arnproxy.com/account/api/v1/residential/orders/status",
    headers=headers,
    timeout=(10, 30), allow_redirects=False
)
print(response.status_code, response.text)
# No automatic write retry.
```

### javascript

```javascript
const headers = { Authorization: `Bearer ${process.env.ARNPROXY_API_KEY}` };
headers['Idempotency-Key'] = 'YOUR_SAVED_OPERATION_KEY';
const response = await fetch("https://www.arnproxy.com/account/api/v1/residential/orders/status", {
  method: 'GET', headers, redirect: 'error',
  signal: AbortSignal.timeout(30000)
});
console.log(response.status, await response.text());
// A write timeout is ambiguous; query its saved operation.
```

### php

```php
<?php
$headers = ['Accept: application/json',
    'Authorization: Bearer '.getenv('ARNPROXY_API_KEY')];
$headers[] = 'Idempotency-Key: YOUR_SAVED_OPERATION_KEY';
$ch = curl_init('https://www.arnproxy.com/account/api/v1/residential/orders/status');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_SSL_VERIFYPEER => true, CURLOPT_SSL_VERIFYHOST => 2,
    CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 30,
]);
$result = curl_exec($ch);
if ($result === false) {
    // Do not repeat a write; use the original operation key.
    throw new RuntimeException('Transport result unknown');
}
echo curl_getinfo($ch, CURLINFO_HTTP_CODE).PHP_EOL.$result;
curl_close($ch);
```

### go

```go
package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
  "time"
)

func main() {
  client := &http.Client{Timeout: 30*time.Second,
    CheckRedirect: func(req *http.Request, via []*http.Request) error {
      return http.ErrUseLastResponse
    }}
  var body io.Reader
  req, err := http.NewRequest("GET", "https://www.arnproxy.com/account/api/v1/residential/orders/status", body)
  if err != nil { panic(err) }
  req.Header.Set("Authorization", "Bearer "+os.Getenv("ARNPROXY_API_KEY"))
  req.Header.Set("Idempotency-Key", "YOUR_SAVED_OPERATION_KEY")
  res, err := client.Do(req); if err != nil { panic(err) }
  defer res.Body.Close()
  data, err := io.ReadAll(res.Body); if err != nil { panic(err) }
  fmt.Println(res.StatusCode, string(data))
}
```

### csharp

```csharp
using System;
using System.IO;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

using var handler = new HttpClientHandler { AllowAutoRedirect = false };
using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(30) };
using var request = new HttpRequestMessage(HttpMethod.Get,
    "https://www.arnproxy.com/account/api/v1/residential/orders/status");
request.Headers.Authorization = new AuthenticationHeaderValue(
    "Bearer", Environment.GetEnvironmentVariable("ARNPROXY_API_KEY"));
request.Headers.Add("Idempotency-Key", "YOUR_SAVED_OPERATION_KEY");
using var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
// Never automatically retry an ambiguous write.
```

### java

```java
import java.net.URI;
import java.net.http.*;
import java.nio.charset.StandardCharsets;
import java.nio.file.*;

// Inside your application method:
var client = HttpClient.newHttpClient();
var request = HttpRequest.newBuilder(URI.create("https://www.arnproxy.com/account/api/v1/residential/orders/status"))
    .header("Authorization", "Bearer " + System.getenv("ARNPROXY_API_KEY"))
    .header("Accept", "application/json")
    .header("Idempotency-Key", System.getenv("ARNPROXY_OPERATION_KEY"))
    .GET()
    .build();
var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
```

## 응답 · HTTP 200

```json
{
  "ok": true,
  "data": {
    "state": "accepted",
    "mode": "topup",
    "delivery_state_at_acceptance": "queued",
    "currency": "TRY",
    "total": "15.00",
    "total_minor": 1500,
    "gb": 1,
    "days": 30,
    "target_package_id": 20001,
    "order": {
      "id": 20002,
      "number": "1000020002",
      "location_id": 20,
      "time_id": 201,
      "last_service_date": "2030-02-01"
    },
    "accepted_at": "2030-01-01T12:00:00+00:00",
    "automatic_renewal": false,
    "source": "existing_website_residential_delivery",
    "replayed": true,
    "delivery": {
      "state": "delivered",
      "queue_state": "success",
      "poll_after_seconds": null,
      "provider_live_check": false,
      "automatic_retry_started": false,
      "package_id": 20001
    }
  },
  "meta": {
    "request_id": "000000000000000000000001",
    "phase": "public_v1",
    "source": "arnproxy_records"
  }
}
```

| 이름 | 유형 | 조건부 | 설명 |
|---|---|---|---|
| `ok` | boolean | — | 성공 여부. false이면 error.code를 확인하세요. |
| `data` | object | — | 작업별 결과이며 예제는 설명용 합성 데이터입니다. |
| `data.state` | string | — | 기록/작업 상태. accepted는 배송 완료가 아니며 completed는 연결 테스트가 아닙니다. |
| `data.mode` | string | — | mode의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `data.delivery_state_at_acceptance` | string | — | delivery state at acceptance의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `data.currency` | string | — | 계정 거래 통화: TRY 또는 USD. |
| `data.total` | string | — | 금액. 정밀도를 위해 반환된 문자열/정수 표현을 유지하세요. |
| `data.total_minor` | integer | — | 최소 통화 단위 정수: 1000은 10.00 TRY/USD입니다. |
| `data.gb` | integer | — | 트래픽 양. 목록/설정 작업은 트래픽을 구매하지 않습니다. |
| `data.days` | integer | — | 요금제 기간(일). GB 요금제의 트래픽 양과 별개입니다. |
| `data.target_package_id` | integer | — | target package id의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `data.order` | object | — | order의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `data.order.id` | integer | — | 관련 ARNPROXY 기록 ID. 공급자 내부 ID 대신 사용하세요. |
| `data.order.number` | string | — | 표시 주문 번호이며 id를 요구하는 필드와 바꿔 쓸 수 없습니다. |
| `data.order.location_id` | integer | — | 로컬 카탈로그의 위치 또는 제품 유형 ID. |
| `data.order.time_id` | integer | — | 로컬 기간/GB 요금제 ID이며 일수나 GB 수량이 아닙니다. |
| `data.order.last_service_date` | string | — | 마지막 서비스일: 현재, 이전 또는 견적 예상일. 예상만으로 갱신되지는 않습니다. |
| `data.accepted_at` | string | — | API가 반환하는 형식의 타임스탬프. 예제 날짜는 합성값입니다. |
| `data.automatic_renewal` | boolean | — | automatic renewal의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `data.source` | string | — | 데이터 출처. 로컬 기록과 실시간 공급자 조회는 서로 다른 근거입니다. |
| `data.replayed` | boolean | — | 동일 작업의 저장된 결과이며 새 결제/작업의 증거가 아닙니다. |
| `data.delivery` | object | — | 현재 로컬 배송 상태이며 저장된 결제 접수와 별개입니다. |
| `data.delivery.state` | string | — | 기록/작업 상태. accepted는 배송 완료가 아니며 completed는 연결 테스트가 아닙니다. |
| `data.delivery.queue_state` | string | — | 백그라운드 대기열의 저장된 상태/시간. 조회해도 작업이 재시작되지 않습니다. |
| `data.delivery.poll_after_seconds` | integer|null | — | 권장 조회 간격. 동일 주문/작업을 추적하세요. |
| `data.delivery.provider_live_check` | boolean | — | 가격/로컬 결과만으로 공급자나 재고가 보장되지는 않습니다. |
| `data.delivery.automatic_retry_started` | boolean | — | 이 조회가 자동 재시도를 시작했는지 여부. 예제는 false입니다. |
| `data.delivery.package_id` | integer | — | 관련 ARNPROXY 기록 ID. 공급자 내부 ID 대신 사용하세요. |
| `meta` | object | — | 요청 추적 및 데이터 출처 메타데이터. |
| `meta.request_id` | string | — | 이 HTTP 요청의 추적 ID이며 작업 키나 주문 ID가 아닙니다. |
| `meta.phase` | string | — | phase의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요. |
| `meta.source` | string | — | 데이터 출처. 로컬 기록과 실시간 공급자 조회는 서로 다른 근거입니다. |

## 동작 및 주요 참고 사항

- 패키지와 목록 ID는 ARNPROXY 기록 ID이며 공급자 키가 아닙니다. 오래된 스냅샷은 접근을 허용하지 않습니다. 필요 시 residential_package_refresh를 사용하세요.
- mode=new는 패키지 생성, mode=topup은 GB 추가입니다. residential_catalog/quote를 먼저 사용하세요. 잔액 접수와 백그라운드 배송은 별개이며 같은 작업 키로 추적합니다.

인증 및 검증 단계에서 실행 전에 요청이 거부될 수 있습니다. 오류 문서를 확인하고 지원 문의용 request_id를 보관하세요. 키나 비밀번호를 보내지 마세요.

[오류 및 제한](https://docs.arnproxy.com/ko/api-v1/errors)
