| name | shopify-known-pitfalls |
| description | Identify and avoid Shopify API anti-patterns: ignoring userErrors, wrong API version,
REST instead of GraphQL, missing GDPR webhooks, and webhook timeout issues.
Use when reviewing a Shopify codebase, preparing for App Store submission, or debugging mysterious API failures.
Trigger with phrases like "shopify mistakes", "shopify anti-patterns",
"shopify pitfalls", "shopify what not to do", "shopify code review".
|
| allowed-tools | Read, Grep |
| version | 2.7.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
| tags | ["saas","ecommerce","shopify"] |
| compatibility | Designed for Claude Code |
Shopify Known Pitfalls
Overview
The 10 most common mistakes when building Shopify apps, with real API examples showing the wrong way and the right way.
Prerequisites
- Existing Shopify app codebase to review or audit
- Familiarity with GraphQL Admin API query patterns and response shapes
- Access scopes configured for the APIs your app uses
@shopify/shopify-api v9+ installed (for code examples)
Instructions
Each pitfall includes a wrong-way and right-way code example. See Pitfall Examples for all 10 complete code comparisons.
Pitfall #1: Not Checking userErrors (The #1 Mistake)
Shopify GraphQL mutations return HTTP 200 even when they fail. The errors are in userErrors. Always check userErrors.length > 0 before accessing the result.
Pitfall #2: Using REST When GraphQL Is Required
REST Admin API is legacy as of October 2024. New public apps after April 2025 must use GraphQL. GraphQL also lets you request only the fields you need.
Pitfall #3: Ignoring API Version Deprecation
Shopify deprecates API versions ~12 months after release. Use LATEST_API_VERSION from @shopify/shopify-api and monitor x-shopify-api-deprecated-reason response headers.
Pitfall #4: Missing Mandatory GDPR Webhooks
Your app will be rejected from the App Store without customers/data_request, customers/redact, and shop/redact webhook handlers.
Pitfall #5: Webhook Handler Takes Too Long
Shopify expects a 200 response within 5 seconds. Respond immediately and queue work asynchronously, otherwise Shopify retries and creates duplicates.
Pitfall #6: Using ProductInput on API 2024-10+
The ProductInput type was split into ProductCreateInput and ProductUpdateInput in 2024-10. Use the specific type for each operation.
Pitfall #7: Not Using Cursor Pagination
Shopify uses Relay-style cursor pagination, not page numbers. Use after / endCursor with pageInfo.
Pitfall #8: Requesting 250 Items Per Page
first: 250 with nested connections creates enormous query costs that THROTTLE immediately. Use first: 50 or smaller with nested resources.
