Catalog GraphQL

Store-scoped catalog GraphQL over HTTP. Use commerce.product:read to query and commerce.product:write to mutate. See Commerce API Scopes.

Endpoint: POST /v2/commerce/stores/{storeId}/catalog-subgraph

Send the same store ID in the {storeId} path and the x-store-id header. The header is required. If they differ, the subgraph uses the header.

Rate limit: Read RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset on every response. On HTTP 429, wait for RateLimit-Reset or Retry-After. See Handle rate limits.

The GraphQL domain model uses SKU / SKU group (not a Product type). PAT scopes stay commerce.product:* for historical naming.

Sidebar is grouped by action/resource. Expand a resource, then Query (commerce.product:read, 27 fields) or Mutation (commerce.product:write, 108 fields).

Example query

Requires commerce.product:read. See sku for the full schema.

query GetSku($id: String!) {
  sku(id: $id) {
    id
    name
    status
  }
}

curl -X POST "https://api.godaddy.com/v2/commerce/stores/{storeId}/catalog-subgraph" \
  -H "Authorization: Bearer $GODADDY_PAT" \
  -H "Content-Type: application/json" \
  -H "x-store-id: {storeId}" \
  -d '{
    "query": "query GetSku($id: String!) { sku(id: $id) { id name status } }",
    "variables": { "id": "SKU_ID" }
  }'

Example mutation

Requires commerce.product:write. See createSku for the full schema.

mutation CreateSku($input: CreateSKUInput!) {
  createSku(input: $input) {
    id
    name
    status
  }
}

HTTP reference

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

curl -X POST "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/catalog-subgraph" \  -H "x-store-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "query": "query GetSku($id: String!) { sku(id: $id) { id name status } }",    "variables": {      "id": "SKU_ID"    }  }'

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

Last updated on