Connector Versioning Policy

Shopify maintains a well-defined versioning policy for its APIs, which directly impacts the lifecycle of the Sales Layer Shopify connector. Understanding how Shopify manages its API versions is essential to grasping why Sales Layer develops new connector versions and how often migrations may be required.

Official documentation is available at:
🔗 Shopify API Versioning Policy

Key aspects of Shopify's versioning policy

• Quarterly releases: Shopify launches a new API version every three months (January, April, July, and October).
• 12-month support window: Each version is supported for one year from its release date. After that period, the version is deprecated and no longer available.
• Explicit version selection: API requests must specify the desired version via the X-Shopify-API-Version header or by including it in the endpoint URL.
• Guaranteed backward compatibility: Shopify guarantees no breaking changes within a version during its 12-month support period.
• Automatic sunset: Once a version's 12 months are over, Shopify disables it. Any integrations using outdated versions will stop working.

Sales Layer Versioning Policy

Sales Layer maintains its own versioning system for the Shopify connector, aligned with the API versions supported by Shopify. This system aims to ensure long-term compatibility with Shopify services, facilitate migration processes, and improve transparency around connector changes.

Commitment to active versions

Sales Layer maintains the objective of having at least two active and stable connector versions, each compatible with one of the four Shopify API versions supported simultaneously.
This policy is intended to ensure service continuity and minimize risks related to the sunset of older versions.
The goal is to maintain at least a 3-month and at most a 9-month difference between the APIs supported by active versions.
Currently, the connector displays the compatible Shopify API version to the client
Every migration is communicated in advance and accompanied by documentation, step-by-step instructions, and technical support if needed.

Each new connector version may introduce changes in fields, behavior, or underlying architecture. Common examples include:

• Changes in field names or types (e.g., inventory_management replaced by tracked).
• Fields deprecated or unsupported in newer API versions.
• New permissions required in the client’s custom app.
• Adjustments in synchronization logic (e.g., transition to GraphQL, changes in visibility rules).

These changes may require remapping fields, updating permissions in Shopify, or manually validating existing configurations. For this reason, all migrations are performed in a controlled and assisted manner.
The current version is mentioned in the connector Activity Register tab:

Please refer to the FAQS about Versioning for more info.