Skip to Content

Shopify connector for Jitterbit Integration Studio

Summary

The Shopify connector establishes access to Shopify.

The Shopify connector provides an interface for creating a Shopify connection, the foundation used for generating instances of Shopify activities. These activities, once configured, interact with Shopify through the connection.

The Shopify connector is accessed from the design component palette's Project endpoints and connectors tab (see Design component palette).

Connector overview

This connector is used to first configure a Shopify connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Shopify connection and its activities are referred to as a Shopify endpoint:

Shopify activity types

  • Read: Retrieves all object data from Shopify and is intended to be used as a source in an operation.

  • Query: Queries specified object data from Shopify and is intended to be used as a source in an operation.

  • Create: Creates object data in Shopify and is intended to be used as a target in an operation.

  • Update: Updates object data in Shopify and is intended to be used as a target in an operation.

  • Delete: Deletes object data from Shopify and is intended to be used as a target in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and supported API versions

The Shopify connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The Shopify connector uses the Shopify REST Admin API version 2022-04, 2023-01, 2023-04, 2023-07, 2023-10, 2024-01, 2024-04, or 2024-07 depending on the selection in a Shopify connection. Refer to the API documentation for information on the schema nodes and fields.

Important

Shopify releases a new API version every three months, and maintains each release version for a minimum of twelve months. Once an API version is deprecated, Shopify will no longer maintain that version, and any API calls requesting that version will be automatically routed to the oldest stable version currently supported.

Shopify may deprecate certain endpoints with the introduction of a new API version. As a result, you may need to change your apps and activity configurations due to changed or retired features.

Deprecated API versions and endpoints are announced in Shopify's change log, where any further details and any relevant migration information is available.

Rate limits

The Shopify REST Admin API enforces a rate limit of 40 requests per app per store per minute. This allotment replenishes at a rate of 2 requests per second. The rate limit is increased for Shopify Plus stores. For more information on the rate limit, see Shopify REST Admin API rate limits.

Troubleshooting

If you experience issues with the Shopify connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for cloud agents or for private agents) to generate additional log files and data.

  4. If using private agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.shopify" level="DEBUG"/>

  5. If using private agents, you can check the agent logs for more information.

  6. For additional troubleshooting considerations, see Operation troubleshooting.