orderByExternalId

query

Requires commerce.order:read.

Query orderByExternalId on the order subgraph (Order).

Required headers

Header	Required	Description
`x-store-id`	Yes	ID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: `extensions.code: "UNAUTHENTICATED"`.

Go to Authentication for credential setup.

Arguments

externalId String! required
channelId String! required

Possible returns

Order Order

query GetOrderByExternalId($externalId: String!, $channelId: String!) {  orderByExternalId(externalId: $externalId, channelId: $channelId) {    id    createdAt    updatedAt    externalId    cartId    number  }}

{  "data": {    "orderByExternalId": {      "id": "ID_VALUE",      "createdAt": "2026-01-15T12:00:00.000Z",      "updatedAt": "2026-01-15T12:00:00.000Z",      "externalId": "EXTERNAL_ID",      "cartId": "CART_ID",      "number": "NUMBER_VALUE"    }  }}

Last updated on