Skip to content

improvement(shopify): pin Admin API to supported 2025-10 via shared constant#5895

Merged
waleedlatif1 merged 2 commits into
stagingfrom
shopify-api-version-bump
Jul 23, 2026
Merged

improvement(shopify): pin Admin API to supported 2025-10 via shared constant#5895
waleedlatif1 merged 2 commits into
stagingfrom
shopify-api-version-bump

Conversation

@waleedlatif1

@waleedlatif1 waleedlatif1 commented Jul 23, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Every Shopify tool and the credential validator hardcoded the retired 2024-10 Admin API version. Retired versions still function (Shopify forward-falls to the oldest supported version) but the served version drifts silently each quarter and emits deprecation signals.
  • Added apps/sim/tools/shopify/constants.ts exporting SHOPIFY_API_VERSION as the single source of truth, pinned to the supported 2025-10 (supported through Oct 2026).
  • Wired all 21 Shopify tools, the token-service-account validator, and the OAuth store route to the shared constant — no more per-file inline version. Next bump is a one-line change.
  • Derived the validator test's expected URL from the constant so it can't drift again.

Compatibility

Our operations already use modern 2024-10+ shapes — ProductCreateInput / ProductUpdateInput (new product model; variants is output-only, not the removed inline ProductInput.variants), orderCancel new signature, CustomerInput, InventoryAdjustQuantitiesInput, fulfillmentCreate. Because 2024-10 is retired, Shopify already forward-serves us ~2025-07 in production today, so this is a small, explicit step from what's effectively already live.

Type of Change

  • Improvement

Testing

  • Typecheck clean; validator tests pass (11); Biome + check:api-validation pass.
  • Not yet smoke-tested against a live store — recommend one list_products read post-merge to close the loop.

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@waleedlatif1
improvement(shopify): pin Admin API to supported 2025-10 via shared c…
4247286 
…onstant

Every Shopify tool and the credential validator hardcoded the retired 2024-10
Admin API version. Retired versions still work (Shopify forward-falls to the
oldest supported version) but the served version drifts silently and emits
deprecation signals.

- Add apps/sim/tools/shopify/constants.ts exporting SHOPIFY_API_VERSION as the
  single source of truth; bump to the supported 2025-10.
- Wire all 21 Shopify tools, the token-service-account validator, and the OAuth
  store route to the shared constant (no more per-file inline version).
- Derive the validator test's expected URL from the constant so it can't drift.

Our operations already use modern 2024-10+ shapes (ProductCreateInput /
ProductUpdateInput new product model, orderCancel new signature, CustomerInput,
InventoryAdjustQuantitiesInput, fulfillmentCreate), none of the removed inline
ProductInput.variants pattern — so the bump is a small, explicit step forward
from the version Shopify already forward-serves.
@vercel

vercel Bot commented Jul 23, 2026 •
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
docs Skipped Skipped Jul 23, 2026 7:09pm

Request Review

@cursor

cursor Bot commented Jul 23, 2026 •
edited
Loading

Copy link
Copy Markdown

PR Summary

Medium Risk
Touches every Shopify Admin API call path (tools, credential validation, OAuth connect); version bump could surface API behavior differences until live smoke tests run.

Overview
Introduces SHOPIFY_API_VERSION in apps/sim/tools/shopify/constants.ts (pinned to 2025-10) and replaces scattered inline 2024-10 Admin API paths with that single export.

All Shopify GraphQL tools, the token-service-account validator, and the OAuth store route (shop.json validation) now build URLs from the same constant. The validator drops its local duplicate version string; its test asserts the fetch URL using SHOPIFY_API_VERSION so it stays aligned on future bumps.

Reviewed by Cursor Bugbot for commit 4247286. Configure here.

@greptile-apps

greptile-apps Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Centralizes Shopify Admin API versioning and pins all affected integrations to 2025-10.

  • Adds a dependency-free shared SHOPIFY_API_VERSION constant.
  • Updates 21 Shopify tools, the credential validator, and the OAuth store lookup to use it.
  • Updates the validator test URL to follow the shared version.

Confidence Score: 5/5

The PR appears safe to merge, with the Shopify API-version centralization consistently applied and no concrete regressions identified.

The shared constant is dependency-free, resolves in route, validator, test, and tool build contexts, and all changed request paths preserve their prior host, method, payload, and response behavior while updating only the API version segment.

Important Files Changed

Filename Overview
apps/sim/tools/shopify/constants.ts Adds a dependency-free shared constant pinning Shopify Admin API requests to version 2025-10.
apps/sim/app/api/auth/oauth2/shopify/store/route.ts Uses the shared API version for the post-OAuth Shopify shop lookup without changing request behavior.
apps/sim/lib/credentials/token-service-accounts/validators/shopify.ts Replaces the validator-local API version with the shared Shopify constant.
apps/sim/lib/credentials/token-service-accounts/validators/shopify.test.ts Updates the expected validator URL to use the centralized API version.
apps/sim/tools/shopify/create_product.ts Representative Shopify GraphQL tool now constructs its endpoint using the shared API version; the operation and response handling are unchanged.
apps/sim/tools/shopify/list_products.ts Representative Shopify read tool now uses the shared API version while preserving its existing query and response contract.

Reviews (1): Last reviewed commit: "improvement(shopify): pin Admin API to s..." | Re-trigger Greptile

@waleedlatif1
chore(shopify): remove dead ShopifySetInventoryParams type
57cb264 
Surfaced by /validate-integration: unexported, unused (no set_inventory tool).
@waleedlatif1
waleedlatif1 merged commit bc237a0 into staging Jul 23, 2026
13 checks passed
@waleedlatif1
waleedlatif1 deleted the shopify-api-version-bump branch July 23, 2026 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@waleedlatif1