Orders GraphQL

Commerce order GraphQL over HTTP. Use commerce.order:read to query; mutations require one of commerce.order:create, :update, :cancel, or :complete. See Commerce API Scopes.

Endpoint: POST /v1/commerce/order-subgraph

Select the store with a required x-store-id header — there is no {storeId} path segment on this endpoint. Mutations that take an input object also include a required context.storeId; id-only mutations (e.g. cancelOrder) rely on the header alone.

Order and line-item IDs are opaque global IDs shaped like Order_<KSUID> and LineItem_<KSUID> (e.g. Order_2N8x…) — not numeric or base64-encoded. Pass the full value verbatim wherever an id or orderId argument appears.

Sidebar is grouped by action/resource. Expand a resource, then Query (commerce.order:read, 6 fields) or Mutation (15 fields).

Example query

Requires commerce.order:read. See orderById for the full schema.

query GetOrder($id: ID!) {
  orderById(id: $id) {
    id
    number
    statuses { status }
  }
}

curl -X POST "https://api.godaddy.com/v1/commerce/order-subgraph" \
  -H "Authorization: Bearer $GODADDY_PAT" \
  -H "Content-Type: application/json" \
  -H "x-store-id: $STORE_ID" \
  -d '{
    "query": "query GetOrder($id: ID!) { orderById(id: $id) { id number statuses { status } } }",
    "variables": { "id": "ORDER_ID" }
  }'

Example mutation

Requires the scope matching the operation (e.g. commerce.order:cancel). See addOrder for the full schema.

mutation CancelOrder($id: ID!, $force: Boolean) {
  cancelOrder(id: $id, force: $force) {
    id
    statuses { status }
  }
}

Error handling

This is a GraphQL endpoint, so most failures still return HTTP 200. Resolver and authorization errors are reported inside the errors array — inspect errors[].extensions.code rather than keying off the HTTP status. Only malformed GraphQL documents fail at the transport layer with HTTP 400.

{
  "data": null,
  "errors": [
    {
      "message": "Unauthorized",
      "extensions": { "code": "UNAUTHENTICATED" }
    }
  ]
}

HTTP reference

OpenAPI contract for the subgraph POST (headers, auth, response envelope):

curl -X POST "https://example.com/v1/commerce/order-subgraph" \  -H "x-store-id: string" \  -H "Content-Type: application/json" \  -d '{    "query": "query GetOrder($id: ID!) { orderById(id: $id) { id number statuses { status } } }",    "variables": {      "id": "ORDER_ID"    }  }'

{  "data": {},  "errors": [    {}  ]}

Last updated on