GET `/v1/orders/{orderId}`

Get order intake status

Where an order your integration sent stands. A test key reads only its integration's simulated orders and a live key only its live ones: an order of the other mode is 404 order_not_found.

Key	Required. See Authentication.
Capability	`order-intake`
Scope	`orders.read`
Price	1 credit, per call. How pricing works.
Estimate	Add `estimate=true` for a free quote. With estimate=true the 200 body is EstimateResponse (a priced quote for exactly this request), not the schema documented under responses.200; nothing is reserved or dispatched.

Example

curl -s "https://api.compudime.com/v1/orders/{orderId}" \
  -H "Authorization: Bearer $PUBLIC_API_KEY"

Parameters

Name	In	Type	Description
`orderId` required	path	string	The orderId returned by POST /v1/orders.
`fields`	query	string	Comma-separated orders fields to include (see x-compudime-field-catalog), or * for every field the key may see. Omitted: a flat-priced endpoint returns every field; once IT prices the endpoint by field count (includedFields in x-compudime-pricing), an omitted fields returns the standard set at the base price and each field beyond the included count adds extraFieldCost. An unknown or denied field is a free 400 field_not_allowed.
`estimate`	query	boolean	When true, returns EstimateResponse instead of the normal body and never reserves credits: the request is authenticated, authorized and field-resolved exactly like a real call, then priced by billing (base cost plus extra-field credits for the resolved fields) and returned without dispatching to the store. Free of charge. Default: false.

Responses

Status	Description	Body
`200`	The order and where it stands on its way to the POS: dispatchState pending_pos_adapter (queued), dispatched (in the POS), parked (not sent, with the reason) or simulated (a test key's, final).	`OrderStatus`
`401`	Public API key is missing, invalid, or revoked.	`Problem`
`402`	The request was blocked by billing policy: no_api_plan (no plan funds this meter), billing_card_missing, billing_card_failed, usage_exhausted, overage_cap_reached, subscription_paused, sandbox_exhausted, or billing_blocked. A key the store pays for under its approval gets grant_cap_exceeded (the store's monthly limit for your calls) or payer_billing_blocked (the store cannot be charged right now; ask the store owner) instead: what is wrong with the store's billing is not shown to it.	`Problem`
`403`	The API key is not enabled for this endpoint.	`Problem`
`404`	The order intake request was not found.	`Problem`
`405`	The requested method is not allowed for this endpoint.	`Problem`
`429`	Too many requests from this API key (code rate_limited). Each key has its own request budget at the API edge, refilled continuously; it covers every authenticated endpoint, including the free ones, and is checked before anything is billed or sent to the store. Billed endpoints are also subject to the store plan's per-minute ceiling, which answers the same problem code. Wait at least Retry-After seconds before the next request with this key, then resume; if 429 answers again, back off exponentially (double the wait each time, up to a minute or so) and add random jitter so parallel workers do not retry in step. A 429 is never charged and reserves nothing. Header `Retry-After`: Whole seconds to wait before retrying with this key: the time until the key's next request token at the edge (never less than 1), or 60 when the store plan's per-minute ceiling refused the call.	`Problem`
`500`	The API edge encountered an internal error.	`Problem`
`503`	A required Public API dependency is temporarily unavailable. Also answered, with code endpoint_disabled, while CompuDime has temporarily switched the endpoint off: the whole API, the endpoint's family (x-compudime-family) or this endpoint alone; the detail says which and why. It is checked before anything is validated, reserved or sent to the store, so it is never charged; it is retryable and carries Retry-After. Header `Retry-After`: Sent with code endpoint_disabled: whole seconds to wait before asking again. A switch has no scheduled end, so this is a polling interval (60), not a promise.	`Problem`

Error bodies are problem JSON; every code is listed there.

Fields

Choose with fields=; see Choosing fields.

All fields	`orderId`, `externalOrderId`, `status`, `dispatchState`, `createdAt`, `updatedAt`, `orderMethod`, `shipTo`, `invoice`, `storePrices`, `storeDiscount`, `fulfillment`
Standard set	`orderId`, `externalOrderId`, `status`, `dispatchState`, `createdAt`, `updatedAt`, `orderMethod`, `shipTo`, `invoice`, `storePrices`, `storeDiscount`, `fulfillment`

Access level

What your integration's access level changes here.