GraphQL Admin API reference

The GraphQL Admin API lets you build apps and other integrations for the Shopify admin.

GraphQL endpoint

All GraphQL API queries are made on a single endpoint, which only accepts POST requests:

Learn more about getting started with the GraphQL Admin API.

Available GraphQL Admin API resources

  • Access APIs — View and manage the access that has been granted to you by merchants.

  • App APIs — View and manage an online store's apps.

  • Billing APIs — Get paid for your app by collecting a one-time charge, a fixed monthly fee, or a variable monthly fee based on usage.

  • Bulk operation APIs — Create and manage bulk operations.

  • Common APIs — Common Admin API objects.

  • Customer APIs — Help merchants manage their customer data.

  • Directives — A directive describes additional options to the GraphQL executor. It allows GraphQL to change the result of the query or mutation based on the additional information provided by the directive.

  • Discount APIs — Help merchants to offer flexible discounts and manage their marketing activity.

  • Event APIs — Fetch event data or register webhooks to keep your app synced with the merchant store.

  • Inventory APIs — Manage inventory levels across multiple locations.

  • Metafields APIs — Manage public and private object metafields.

  • Online store APIs — Update a merchant's online storefront and its content.

  • Order APIs — Give merchants new ways to receive, process, and manage their orders.

  • Products and Collections APIs — Access and manipulate a store's catalog using product and collection APIs.

  • Scalars — Scalars are primitive values such as Int or String. GraphQL queries and responses take the form of a hierarchical tree; the leaves on these trees are GraphQL scalars.

  • Shipping and fulfillme