About REST to GraphQL migration

GraphQL is Shopify's technology of choice for building APIs. GraphQL addresses several problems that might sound familiar to anyone who's worked with a REST API.

You can migrate your apps to use the GraphQL Admin API instead of the REST Admin API to take advantage of the benefits of GraphQL.

This section includes guides and resources to help you with the migration process.

Anchor to Why migrate to GraphQLWhy migrate to GraphQL

The GraphQL Admin API offers several advantages over REST:

• Request only what you need: Unlike REST endpoints that return fixed data structures, GraphQL lets you specify exactly which fields you want. This reduces payload sizes and improves performance.
• Single request for related data: Retrieve information about related objects with a single request using connections, eliminating the need to chain multiple REST API calls.
• Strongly typed schema: GraphQL's type system provides built-in documentation and validation, making it easier to understand what data is available and how to request it.
• Better performance: GraphQL's calculated query cost model is more efficient than REST's request-based rate limiting, allowing you to do more with your rate limit budget.
• Future-proof: New Shopify features and improvements are released in GraphQL first. The REST Admin API is in maintenance mode and receives only critical updates.

Anchor to Getting startedGetting started

Refer to the following resources to start migrating from REST to GraphQL:

Migrate to GraphQL from REST

Learn about the things that you need to consider when migrating your app from REST to GraphQL.

Update API calls in your app

Learn how to update your REST API calls to GraphQL API calls using common API client libraries.

Explore GraphQL basics

Learn about the fundamentals of GraphQL.

Anchor to Developer tools and resourcesDeveloper tools and resources

Explore the following developer tools and resources to learn more about Shopify GraphQL APIs.

.dev Assistant

Generate GraphQL operations, convert REST requests to GraphQL operations, and get interactive help with Shopify's AI-powered assistant.

Trained on Shopify data for high accuracy.

Shopify Dev Assistant VS Code Extension

Access AI-powered Shopify development help directly within Visual Studio Code, with automatic GraphQL query execution and GraphiQL integration.

Seamlessly integrates with your local development workflow. Trained on Shopify data for high accuracy.

GraphQL Admin API reference

Consult the complete reference to Shopify’s GraphQL Admin API.

Shopify Admin API GraphiQL explorer

Browse Shopify’s GraphQL Admin API schema and documentation.

GraphQL Storefront API reference

Consult the complete reference to Shopify’s GraphQL Storefront API.

Shopify Storefront API GraphiQL explorer

Browse Shopify’s Storefront API schema and documentation.

Shopify GraphiQL app

Explore your store's data, and test queries and mutations, using the GraphQL Admin and Storefront APIs.