Saved acceptance and current Residential delivery state

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

Authorization

Authorization	`Bearer YOUR_ARNPROXY_API_KEY`
Required permission	`read`
Accept	`application/json`
Idempotency-Key	16–100 letters, digits, _ or -. Persist and reuse the same value for the same operation.

Parameters

Name	Type	Description
`Idempotency-Key` headerRequired	`string`	16–100 letters/digits/_/-. Keep the same value for the operation/status; do not reuse with a different body.

Request example

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'

Examples are not executed on this page. Keep the API key in a server-side environment variable; do not put real keys in URLs or browser code. Prepare request.json for POST examples.

Responses

200Success response

application/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"
    }
}

Response fields and types

Name	Type	Description
`ok`	`boolean`	Success envelope flag; on false inspect error.code.
`data`	`object`	Operation-specific result; examples are illustrative and synthetic.
`data.state`	`string`	Record/operation state. accepted is not delivery; completed is not a connection test.
`data.mode`	`string`	Operation-specific mode value; preserve its demonstrated type and consult the behavior notes.
`data.delivery_state_at_acceptance`	`string`	Operation-specific delivery state at acceptance value; preserve its demonstrated type and consult the behavior notes.
`data.currency`	`string`	Account transaction currency: TRY or USD.
`data.total`	`string`	Money amount; preserve the returned string/integer representation for precision.
`data.total_minor`	`integer`	Integer minor units: 1000 means 10.00 TRY/USD.
`data.gb`	`integer`	Traffic amount; list/settings operations do not purchase traffic.
`data.days`	`integer`	Plan duration in days, separate from a GB plan’s traffic amount.
`data.target_package_id`	`integer`	Operation-specific target package id value; preserve its demonstrated type and consult the behavior notes.
`data.order`	`object`	Operation-specific order value; preserve its demonstrated type and consult the behavior notes.
`data.order.id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.order.number`	`string`	Display order number; not interchangeable with fields requesting an id.
`data.order.location_id`	`integer`	Local catalog location or product-type ID.
`data.order.time_id`	`integer`	Local period/GB-plan record ID, not a day or GB count.
`data.order.last_service_date`	`string`	Last service day: current, previous or projected by the quote. A projection does not renew.
`data.accepted_at`	`string`	Timestamp in the API’s returned representation; example dates are synthetic.
`data.automatic_renewal`	`boolean`	Operation-specific automatic renewal value; preserve its demonstrated type and consult the behavior notes.
`data.source`	`string`	Data source; local records and a live provider lookup are different evidence.
`data.replayed`	`boolean`	Saved result for the same operation was returned, not proof of a new debit/action.
`data.delivery`	`object`	Current local delivery state, separate from saved payment acceptance.
`data.delivery.state`	`string`	Record/operation state. accepted is not delivery; completed is not a connection test.
`data.delivery.queue_state`	`string`	Stored background queue state/time; reading it does not restart work.
`data.delivery.poll_after_seconds`	`integer\|null`	Suggested polling delay; follow the same order/operation.
`data.delivery.provider_live_check`	`boolean`	A price/local result is not by itself a provider or stock guarantee.
`data.delivery.automatic_retry_started`	`boolean`	Whether this lookup started an automatic retry; false in these examples.
`data.delivery.package_id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`meta`	`object`	Request correlation and data-source metadata.
`meta.request_id`	`string`	This HTTP request’s correlation ID, not an operation key or order ID.
`meta.phase`	`string`	Operation-specific phase value; preserve its demonstrated type and consult the behavior notes.
`meta.source`	`string`	Data source; local records and a live provider lookup are different evidence.

Error response

HTTP 401 · INVALID_API_KEY

{
  "ok": false,
  "error": { "code": "INVALID_API_KEY" },
  "meta": { "request_id": "000000000000000000000001" }
}

Authentication and validation may reject a request before execution. Consult the error reference and retain request_id when contacting support. Never send keys or passwords. Errors & limits →

Behavior & important notes

Package and list IDs are ARNPROXY record IDs, not upstream package keys or list IDs. A stale package snapshot cannot grant access; refresh it with residential_package_refresh when needed.
mode=new creates a package; mode=topup adds GB to an existing one. Use residential_catalog/quote first. Balance acceptance and background delivery are separate; follow the same operation key.