ARNPROXY

Order summary

GET/account/api/v1/orders/{id}

Authorization

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Required permissionread
Acceptapplication/json

Parameters

NameTypeDescription
id
pathRequired
integerAn owned record ID for this operation; 1–2147483647. Not a display order number or supplier ID.

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 \
    'https://www.arnproxy.com/account/api/v1/orders/YOUR_ORDER_ID'

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": {
        "id": 10001,
        "number": "1000010001",
        "quantity": 1,
        "local_status_code": 1,
        "last_service_date": "2030-02-01"
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}
Response fields and types
NameTypeDescription
okbooleanSuccess envelope flag; on false inspect error.code.
dataobjectOperation-specific result; examples are illustrative and synthetic.
data.idintegerRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.numberstringDisplay order number; not interchangeable with fields requesting an id.
data.quantityintegerSelected or ordered proxy quantity.
data.local_status_codeintegerExisting website order status code; use order_delivery to assess fulfillment.
data.last_service_datestringLast service day: current, previous or projected by the quote. A projection does not renew.
metaobjectRequest correlation and data-source metadata.
meta.request_idstringThis HTTP request’s correlation ID, not an operation key or order ID.
meta.phasestringOperation-specific phase value; preserve its demonstrated type and consult the behavior notes.
meta.sourcestringData 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

  • id is the ARNPROXY order record ID, not its displayed number. Delivery lookup does not start live provider checks or redelivery.

Search the current language. Close with Esc