Shopify connection

Introduction

A Shopify connection, created using the Shopify connector, establishes access to Shopify. Once a connection is configured, you can create instances of Shopify activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or edit a Shopify connection

A new Shopify connection is created using the Shopify connector from one of these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The Global Connections page (see Create a global endpoint in Global Connections).

An existing Shopify connection can be edited from these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).
• The Global Connections page (see Edit a global endpoint in Global Connections).

Configure a Shopify connection

Each user interface element of the Shopify connection configuration screen is described below.

• Connection name: Enter a name to use to identify the connection. The name must be unique for each Shopify connection and must not contain forward slashes / or colons :. This name is also used to identify the Shopify endpoint, which refers to both a specific connection and its activities.

• Store name: Enter the Shopify store name.

• Authentication type: Select the authentication type, one of Basic authentication or Shopify access token. If you are using a private app, select Basic authentication. If you are using a custom app created in the Shopify admin, select Shopify access token.

• API key: If Basic authentication was selected as the Authentication type, enter the API key for the Shopify instance.

• Password: If Basic authentication was selected as the Authentication type, enter the password for the Shopify instance.

• API access token: If Shopify access token was selected as the Authentication type, enter the API access token for the Shopify instance.

• Optional settings: Click to expand additional settings:

  • Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.

  • API Version: Select the Shopify REST Admin API version, one of 2022-04 (default), 2023-01, 2023-04, 2023-07, 2023-10, 2024-01, 2024-04, or 2024-07. Depending on the API endpoints supported by Shopify in the API version being used, the objects and sub-objects that are available for selection during activity configuration may vary. If changing the API Version for a connection that has existing configured activities, see additional considerations in Change the API version below.

    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.

  • Request Headers: Use this table to add any key-value pairs to be sent with each activity request. Each value added to the table is included in each activity's request schema.

    • Add: Adds a row to the table. Enter a key-value pair for each property.
    • Submit: Saves the key-value pair to the table. Visible when hovering on a row in edit mode.
    • Discard: Discards a new row or any edits made to an existing row. Visible when hovering on a row in edit mode.
    • Edit: Allows you to edit an existing key-value pair. Visible when hovering on an existing row.
    • Delete: Deletes the row from the table. Visible when hovering on an existing row.
    • Clear All: Deletes all rows from the table.

    Important

    Fields in the Request Headers table display the variable icon only in edit mode. For these fields' variable values to be populated at runtime, the agent version must be at least 10.75 / 11.13.

• Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Change the API version

If a Shopify connection has existing configured activities, there are additional considerations to take into account when changing the selected API Version. That is because the objects and sub-objects available for selection in the activity configuration depend on the API endpoints supported by Shopify in the API version being used. If the existing activity configuration uses API endpoints that are not supported in the API version that you are changing to, then those activities will fail unless they are reconfigured.

To prevent this from occurring, follow these steps:

1. Change the API version in the Shopify connection.

2. Open each activity configuration screen where an object or sub-object is selected and click Refresh. On refreshing, the current object and sub-object selection lists will be retrieved using the API version selected in the Shopify connection. Note that Shopify automatically redirects calls of unsupported API versions to the next oldest supported version.

   Important

   If the selected object or sub-object is not supported in the API version being called, the selection may change on refreshing. Pay close attention to make sure that any changed selections are as intended.

3. Select the appropriate object and sub-object supported by the API version being called.

4. Redeploy operations using the connection and activities.

Next steps

After a Shopify connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

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

• Query: Queries 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.