Getting started with the GraphQL Admin and REST Admin APIs

The GraphQL Admin and REST Admin APIs require a Shopify access token (for public apps and custom apps) for making authenticated requests.

To get the access token for a public or custom app, follow the OAuth authorization flow in the OAuth guide. Include the access token as a X-Shopify-Access-Token header in your requests.

If you created your custom app in the Shopify admin, then you need to authenticate the app with access tokens. This is applicable only to custom apps created in the Shopify admin.

The GraphQL Admin API is a GraphQL-based alternative to the REST-based Admin API, and makes the functionality of the Shopify admin available at a single GraphQL endpoint:

You can access the GraphQL Admin API using the GraphiQL app, curl, or any HTTP client:

• Use the GraphiQL app
• Use curl (or your preferred HTTP client)

We recommend installing Shopify’s own GraphiQL app to explore your shop’s data using the GraphQL Admin API. After you've installed the app, you can test it by running the following query:

The following example shows a query for the first five product IDs and handles. Replace {shop} with your store’s domain and {password} with the access token that you generated in the Authentication section.

In GraphQL, queries are the equivalent of REST’s GET action verb. Queries generally begin with one of the objects listed under QueryRoot and can get data from any connections that an object has. Even though a POST is being sent to the GraphQL endpoint, if the body only contains queries, then data is only retrieved and not modified.

The following example shows a query for the quantity of inventory items available at a location:

Mutations are the equivalent of REST’s data-modifying action verbs, such as PUT or DELETE. The following example shows a mutation that increases the available inventory at a location:

You can access the REST Admin API using curl or any other HTTP client. REST Admin API endpoints are organized by resource type. You need to use different API endpoints depending on the service that your app provides.

The following curl request retrieves information by using the Shop resource and the GET /admin/api/2023-10/shop.json endpoint. Replace {shop} with your store’s domain and {password} with the access token that you generated in the Authentication section.

The following example illustrates how to create a product that has a draft status by using the Product resource and the POST /admin/api/2023-10/products.json endpoint.

The following example illustrates how to update the postal code of a customer address with the Customer Address resource and the PUT /admin/api/2023-10/customers{customer_id}/addresses/{address_id}.json endpoint.

Request:

The following example illustrates how to delete an order with the Order resource and the DELETE /admin/api/2023-10/orders/{order_id}.json endpoint.

• Use the Shopify Admin API GraphiQL explorer to build GraphQL queries.
• Explore the GraphQL Admin API reference to learn more about the different resources and endpoints that you can access using the GraphQL Admin API.
• Explore the REST Admin API reference to learn more about the different resources and endpoints that you can access using the REST Admin API.