How do I install the Shopify API REST skill?

Run npx skillmds@latest add orcaqubits/shopify-api-rest in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Shopify API REST safe to use?

This skill has not completed SkillMD's automated safety review yet. Capability flags: makes network calls, reads secrets. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Shopify API REST?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Shopify API REST free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Shopify API REST?

OrcaQubits (@orcaqubits) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Shopify API REST by orcaqubits — Agent Skill

Name: Shopify API REST
Rating: 4.666666666666667 (3 reviews)
Author: OrcaQubits

Shopify API REST

MIGRATION SKILL: Shopify REST Admin API — endpoint patterns, authentication, rate limits, and REST-to-GraphQL migration guide. The REST Admin API is deprecated (October 2024). Use this skill only for maintaining legacy integrations or planning migration to GraphQL.

OrcaQubits Updated Sep 10, 2026

File contents

Shopify REST Admin API (DEPRECATED)

DEPRECATION NOTICE: The Shopify REST Admin API was deprecated in October 2024. All new development MUST use the GraphQL Admin API. This skill exists for maintaining legacy code and planning migration.

Before writing code

Fetch live docs:

Web-search site:shopify.dev rest admin api deprecation for deprecation timeline
Web-search site:shopify.dev migrate rest to graphql for migration guide
Fetch https://shopify.dev/docs/api/admin-rest for REST reference (if maintaining legacy code)

REST API Overview (Legacy)

Endpoints

Base URL: https://{store}.myshopify.com/admin/api/{version}/
Resources: products.json, orders.json, customers.json, etc.
CRUD via HTTP methods: GET, POST, PUT, DELETE

Authentication

Header: X-Shopify-Access-Token: {token}
Same OAuth tokens work for both REST and GraphQL

Rate Limits

Bucket-based: 40 requests per app per store (leaky bucket)
Headers: X-Shopify-Shop-Api-Call-Limit: 32/40
Plus stores: 80 requests

Pagination

Cursor-based via Link header (not page numbers)
rel="next" and rel="previous" links

REST-to-GraphQL Migration

Common Mappings

REST Endpoint	GraphQL Equivalent
`GET /products.json`	`query { products(first: 50) { edges { node { ... } } } }`
`POST /products.json`	`mutation { productCreate(input: {...}) { ... } }`
`PUT /products/{id}.json`	`mutation { productUpdate(input: {...}) { ... } }`
`DELETE /products/{id}.json`	`mutation { productDelete(input: {id: "..."}) { ... } }`
`GET /orders.json`	`query { orders(first: 50) { edges { node { ... } } } }`
`GET /customers.json`	`query { customers(first: 50) { edges { node { ... } } } }`

Key Differences

Aspect	REST	GraphQL
Data shape	Fixed response	Client-defined
Rate limiting	Request count (40/s)	Cost-based (1000 points)
Pagination	Link headers	Cursor arguments
Bulk operations	Not available	`bulkOperationRunQuery`
Webhooks	REST endpoint	Same (subscription via GraphQL)
ID format	Numeric (`12345`)	GID (`gid://shopify/Product/12345`)

ID Conversion

REST uses numeric IDs; GraphQL uses Global IDs (GIDs):

REST: 12345
GraphQL: gid://shopify/Product/12345
Convert: prefix with gid://shopify/{ResourceType}/

Migration Strategy

Audit existing REST calls — list all endpoints and frequencies
Map each REST call to its GraphQL equivalent
Migrate incrementally — replace one endpoint at a time
Leverage bulk operations — replace paginated REST loops with single bulk queries
Update error handling — GraphQL returns 200 with userErrors, not HTTP status codes
Test thoroughly — responses have different shapes

Best Practices

Do NOT write new code against the REST API
Prioritize migrating high-frequency REST calls first
Use bulk operations to replace REST pagination loops
Update ID handling from numeric to GID format
Test migration against a development store

Fetch the Shopify REST-to-GraphQL migration guide for exact endpoint mappings and timeline before planning a migration.

---name: shopify-api-restdescription: MIGRATION SKILL: Shopify REST Admin API — endpoint patterns, authentication, rate limits, and REST-to-GraphQL migration guide. The REST Admin API is deprecated (October 2024). Use this skill only for maintaining legacy integrations or planning migration to GraphQL.---# Shopify REST Admin API (DEPRECATED)> **DEPRECATION NOTICE:** The Shopify REST Admin API was deprecated in October 2024. All new development MUST use the GraphQL Admin API. This skill exists for maintaining legacy code and planning migration.## Before writing code**Fetch live docs**:1. Web-search `site:shopify.dev rest admin api deprecation` for deprecation timeline2. Web-search `site:shopify.dev migrate rest to graphql` for migration guide3. Fetch `https://shopify.dev/docs/api/admin-rest` for REST reference (if maintaining legacy code)## REST API Overview (Legacy)### Endpoints- Base URL: `https://{store}.myshopify.com/admin/api/{version}/`- Resources: `products.json`, `orders.json`, `customers.json`, etc.- CRUD via HTTP methods: GET, POST, PUT, DELETE### Authentication- Header: `X-Shopify-Access-Token: {token}`- Same OAuth tokens work for both REST and GraphQL### Rate Limits- Bucket-based: 40 requests per app per store (leaky bucket)- Headers: `X-Shopify-Shop-Api-Call-Limit: 32/40`- Plus stores: 80 requests### Pagination- Cursor-based via `Link` header (not page numbers)- `rel="next"` and `rel="previous"` links## REST-to-GraphQL Migration### Common Mappings| REST Endpoint | GraphQL Equivalent ||---------------|-------------------|| `GET /products.json` | `query { products(first: 50) { edges { node { ... } } } }` || `POST /products.json` | `mutation { productCreate(input: {...}) { ... } }` || `PUT /products/{id}.json` | `mutation { productUpdate(input: {...}) { ... } }` || `DELETE /products/{id}.json` | `mutation { productDelete(input: {id: "..."}) { ... } }` || `GET /orders.json` | `query { orders(first: 50) { edges { node { ... } } } }` || `GET /customers.json` | `query { customers(first: 50) { edges { node { ... } } } }` |### Key Differences| Aspect | REST | GraphQL ||--------|------|---------|| Data shape | Fixed response | Client-defined || Rate limiting | Request count (40/s) | Cost-based (1000 points) || Pagination | Link headers | Cursor arguments || Bulk operations | Not available | `bulkOperationRunQuery` || Webhooks | REST endpoint | Same (subscription via GraphQL) || ID format | Numeric (`12345`) | GID (`gid://shopify/Product/12345`) |### ID ConversionREST uses numeric IDs; GraphQL uses Global IDs (GIDs):- REST: `12345`- GraphQL: `gid://shopify/Product/12345`- Convert: prefix with `gid://shopify/{ResourceType}/`## Migration Strategy1. **Audit** existing REST calls — list all endpoints and frequencies2. **Map** each REST call to its GraphQL equivalent3. **Migrate incrementally** — replace one endpoint at a time4. **Leverage bulk operations** — replace paginated REST loops with single bulk queries5. **Update error handling** — GraphQL returns 200 with `userErrors`, not HTTP status codes6. **Test thoroughly** — responses have different shapes## Best Practices- Do NOT write new code against the REST API- Prioritize migrating high-frequency REST calls first- Use bulk operations to replace REST pagination loops- Update ID handling from numeric to GID format- Test migration against a development storeFetch the Shopify REST-to-GraphQL migration guide for exact endpoint mappings and timeline before planning a migration.

Frequently asked questions