Agent skill · data analytics · jeremylongshore
shopify-known-pitfalls
Identify and avoid Shopify API anti-patterns: ignoring userErrors, wrong
Why this skill is useful
Provides specific anti-patterns and solutions for Shopify API usage that the AI wouldn't reliably generate on its own.
What it needs
About 3k tokens when loaded. Last updated 2026-08-07. 2,604 stars on the source repository.
What this skill does
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 LATESTAPIVERSION 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/datarequest, 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. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills jeremylongshore/shopify-known-pitfalls