Skip to main content

Get started migrating and test your app

Legacy

The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.

There are a number of helpful tips and resources available for migrating from the REST product APIs to the new GraphQL APIs. As you learn with this guide, new questions may come up - we encourage you to post them in Shopify Community: New GraphQL Product APIs Forum.


Anchor to Create a development store that allows 2,048 variants per productCreate a development store that allows 2,048 variants per product

By default, stores have a limit of 100 variants for each product. We recommend testing your app with a development store that allows products with 2,048 variants. You can create and configure a development store with the Extended Variants developer preview by following these steps:

  1. Log in to your Partner Dashboard.

  2. Select Stores and click Add store > Create development store.

  3. Choose Create a store to test and build.

  4. Enter a unique store name.

  5. Under Build version, select Developer preview.

  6. From the dropdown list, select Extended Variants.

  7. Click Create development store.

You can now test and experiment with the expanded product variant limits in your new dev store.


Anchor to Mapping Product and ProductVariant REST IDs to GraphQL GIDsMapping Product and ProductVariant REST IDs to GraphQL GIDs

When migrating from REST to GraphQL for products and variants, you don't need to restructure your database to include a GraphQL-specific ID column. Instead, you can create the GraphQL global ID (GID) using an existing REST ID.

The following example shows how the GID format is the existing REST ID prefixed with "gid://shopify/Product/" for products and "gid://shopify/ProductVariant/" for variants.

- REST ID: 123456
- GraphQL GID: "gid://shopify/Product/123456"
- REST ID: 654321
- GraphQL GID: "gid://shopify/ProductVariant/654321"

Anchor to Endpoint and Field differences between REST and GraphQLEndpoint and Field differences between REST and GraphQL

A key task will be to map the REST calls your app makes to /products and /variants to the various queries and mutations in GraphQL, including the selection of fields in GraphQL. The REST reference documentation now includes direct mapping between REST HTTP methods and fields and the corresponding GraphQL reference documentation.


Anchor to Get started using the APIGet started using the API

Retrieve data

Learn how to retrieve product data, including for a large number of variants.

Add data

Learn how to add product data, including variants and options.

Edit data

Learn how to edit product data, including variants and options.

Sync data

Learn how you can sync product data from an external source into Shopify.


Was this page helpful?