Residential 배송 상태
GET
/account/api/v1/residential/orders/status권한 인증
| Authorization | Bearer YOUR_ARNPROXY_API_KEY |
|---|---|
| 필요한 권한 | read |
| Accept | application/json |
| Idempotency-Key | 문자, 숫자, _ 또는 -로 16~100자. 같은 작업에는 저장한 동일 값을 사용하세요. |
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
Idempotency-Key | string | 문자/숫자/_/- 16~100자. 작업과 상태 조회에 같은 값을 사용하고 다른 본문에 재사용하지 마세요. |
요청 예제
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'이 페이지에서는 예제를 실행하지 않습니다. API 키는 서버 환경 변수에 보관하고 URL이나 브라우저 코드에 넣지 마세요. POST 예제에는 request.json을 준비하세요.
{"curl":"printf \u0027Authorization: Bearer %s\\n\u0027 \u0022$ARNPROXY_API_KEY\u0022 |\n curl --silent --show-error --header @- \\\n --header \u0027Accept: application\/json\u0027 \\\n --connect-timeout 10 --max-time 30 \\\n --header \u0027Idempotency-Key: YOUR_SAVED_OPERATION_KEY\u0027 \\\n \u0027https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/orders\/status\u0027","python":"import os, requests\n\nheaders = {\u0022Authorization\u0022: \u0022Bearer \u0022 + os.environ[\u0022ARNPROXY_API_KEY\u0022]}\nheaders[\u0022Idempotency-Key\u0022] = \u0022YOUR_SAVED_OPERATION_KEY\u0022\nresponse = requests.get(\n \u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/orders\/status\u0022,\n headers=headers,\n timeout=(10, 30), allow_redirects=False\n)\nprint(response.status_code, response.text)\n# No automatic write retry.","javascript":"const headers = { Authorization: `Bearer ${process.env.ARNPROXY_API_KEY}` };\nheaders[\u0027Idempotency-Key\u0027] = \u0027YOUR_SAVED_OPERATION_KEY\u0027;\nconst response = await fetch(\u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/orders\/status\u0022, {\n method: \u0027GET\u0027, headers, redirect: \u0027error\u0027,\n signal: AbortSignal.timeout(30000)\n});\nconsole.log(response.status, await response.text());\n\/\/ A write timeout is ambiguous; query its saved operation.","php":"\u003C?php\n$headers = [\u0027Accept: application\/json\u0027,\n \u0027Authorization: Bearer \u0027.getenv(\u0027ARNPROXY_API_KEY\u0027)];\n$headers[] = \u0027Idempotency-Key: YOUR_SAVED_OPERATION_KEY\u0027;\n$ch = curl_init(\u0027https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/orders\/status\u0027);\ncurl_setopt_array($ch, [\n CURLOPT_RETURNTRANSFER =\u003E true,\n CURLOPT_HTTPHEADER =\u003E $headers,\n CURLOPT_FOLLOWLOCATION =\u003E false,\n CURLOPT_SSL_VERIFYPEER =\u003E true, CURLOPT_SSL_VERIFYHOST =\u003E 2,\n CURLOPT_CONNECTTIMEOUT =\u003E 10, CURLOPT_TIMEOUT =\u003E 30,\n]);\n$result = curl_exec($ch);\nif ($result === false) {\n \/\/ Do not repeat a write; use the original operation key.\n throw new RuntimeException(\u0027Transport result unknown\u0027);\n}\necho curl_getinfo($ch, CURLINFO_HTTP_CODE).PHP_EOL.$result;\ncurl_close($ch);","go":"package main\n\nimport (\n \u0022fmt\u0022\n \u0022io\u0022\n \u0022net\/http\u0022\n \u0022os\u0022\n \u0022time\u0022\n)\n\nfunc main() {\n client := \u0026http.Client{Timeout: 30*time.Second,\n CheckRedirect: func(req *http.Request, via []*http.Request) error {\n return http.ErrUseLastResponse\n }}\n var body io.Reader\n req, err := http.NewRequest(\u0022GET\u0022, \u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/orders\/status\u0022, body)\n if err != nil { panic(err) }\n req.Header.Set(\u0022Authorization\u0022, \u0022Bearer \u0022+os.Getenv(\u0022ARNPROXY_API_KEY\u0022))\n req.Header.Set(\u0022Idempotency-Key\u0022, \u0022YOUR_SAVED_OPERATION_KEY\u0022)\n res, err := client.Do(req); if err != nil { panic(err) }\n defer res.Body.Close()\n data, err := io.ReadAll(res.Body); if err != nil { panic(err) }\n fmt.Println(res.StatusCode, string(data))\n}","csharp":"using System;\nusing System.IO;\nusing System.Net.Http;\nusing System.Net.Http.Headers;\nusing System.Text;\n\nusing var handler = new HttpClientHandler { AllowAutoRedirect = false };\nusing var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(30) };\nusing var request = new HttpRequestMessage(HttpMethod.Get,\n \u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/orders\/status\u0022);\nrequest.Headers.Authorization = new AuthenticationHeaderValue(\n \u0022Bearer\u0022, Environment.GetEnvironmentVariable(\u0022ARNPROXY_API_KEY\u0022));\nrequest.Headers.Add(\u0022Idempotency-Key\u0022, \u0022YOUR_SAVED_OPERATION_KEY\u0022);\nusing var response = await client.SendAsync(request);\nConsole.WriteLine((int)response.StatusCode);\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n\/\/ Never automatically retry an ambiguous write.","java":"import java.net.URI;\nimport java.net.http.*;\nimport java.nio.charset.StandardCharsets;\nimport java.nio.file.*;\n\n\/\/ Inside your application method:\nvar client = HttpClient.newHttpClient();\nvar request = HttpRequest.newBuilder(URI.create(\u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/orders\/status\u0022))\n .header(\u0022Authorization\u0022, \u0022Bearer \u0022 + System.getenv(\u0022ARNPROXY_API_KEY\u0022))\n .header(\u0022Accept\u0022, \u0022application\/json\u0022)\n .header(\u0022Idempotency-Key\u0022, System.getenv(\u0022ARNPROXY_OPERATION_KEY\u0022))\n .GET()\n .build();\nvar response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.statusCode());"}응답
200성공 응답
{
"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 | 데이터 출처. 로컬 기록과 실시간 공급자 조회는 서로 다른 근거입니다. |
오류 응답
{
"ok": false,
"error": { "code": "INVALID_API_KEY" },
"meta": { "request_id": "000000000000000000000001" }
}인증 및 검증 단계에서 실행 전에 요청이 거부될 수 있습니다. 오류 문서를 확인하고 지원 문의용 request_id를 보관하세요. 키나 비밀번호를 보내지 마세요. 오류 및 제한 →
동작 및 주요 참고 사항
- 패키지와 목록 ID는 ARNPROXY 기록 ID이며 공급자 키가 아닙니다. 오래된 스냅샷은 접근을 허용하지 않습니다. 필요 시 residential_package_refresh를 사용하세요.
- mode=new는 패키지 생성, mode=topup은 GB 추가입니다. residential_catalog/quote를 먼저 사용하세요. 잔액 접수와 백그라운드 배송은 별개이며 같은 작업 키로 추적합니다.