shopify-api-graphql

Shopify GraphQL APIs

Before writing code

Fetch live docs:

1. Fetch https://shopify.dev/docs/api/admin-graphql for Admin API schema
2. Fetch https://shopify.dev/docs/api/storefront for Storefront API schema
3. Web-search site:shopify.dev graphql api versioning for current API versions

Two APIs

Admin API (Server-Side)

Full CRUD on all store resources:

• Endpoint: https://{store}.myshopify.com/admin/api/{version}/graphql.json
• Auth: X-Shopify-Access-Token header
• Use for: product management, order processing, customer data, metafields, fulfillment
• Rate limit: cost-based, max 1,000 points per query. Restore rate varies by plan (100 pts/s Standard, 200 Advanced, 1,000 Plus)

Storefront API (Client-Side)

Read-heavy access for custom storefronts:

• Endpoint: https://{store}.myshopify.com/api/{version}/graphql.json
• Auth: X-Shopify-Storefront-Access-Token header
• Use for: product browsing, cart operations, checkout, customer account
• Rate limit: cost-based (separate budget from Admin API)

API Versioning

Quarterly releases: YYYY-MM (January, April, July, October)

• Each version supported for 12 months after release
• unstable version available for testing upcoming changes
• Always specify version in URL path

Admin API Examples

Query Products

query Products($first: Int!, $after: String) {
  products(first: $first, after: $after) {
    edges {
      node {
        id
        title
        handle
        status
        variants(first: 10) {
          edges {
            node {
              id
              title
              price
              sku
              inventoryQuantity
            }
          }
        }
        metafields(first: 5) {
          edges {
            node {
              namespace
              key
              value
              type
            }
          }
        }
      }
    }
    pageInfo { hasNextPage endCursor }
  }
}

Create Product

mutation ProductCreate($input: ProductInput!) {
  productCreate(input: $input) {
    product {
      id
      title
    }
    userErrors {
      field
      message
    }
  }
}