Get Sales Order Channel Document
GET/api/sales-orders/:salesOrder/document
Gets the original sales-channel order document for a sales order — the raw order snapshot imported from the connected marketplace or cart (Shopify, Amazon, etc.).
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Behavior:
- The document's shape varies by sales channel: it is the channel-specific order record as stored at import time (order identifiers, financial/fulfillment statuses, totals, addresses, and channel metadata). The example below shows a Shopify-shaped document; other channels return their own field sets.
- For documents from channels that expose a connected shop, the
integration_instancerelation is included so the document can be tied back to the specific store connection. - Returns
data: nullfor manually created orders (orders with no sales-channel origin).
Path parameters:
- salesOrder (required): Sales order ID.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.