Shopify

The Shopify connector lets you perform insert, delete, update, and read operations on Shopify.

Supported versions

This connector models the Shopify Admin APIs as a relational database.

Before you begin

Before using the Shopify connector, do the following tasks:

  • In your Google Cloud project:
    • Ensure that network connectivity is set up. For information about network patterns, see Network connectivity.
    • Grant the roles/connectors.admin IAM role to the user configuring the connector.
    • Grant the following IAM roles to the service account that you want to use for the connector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      A service account is a special type of Google account intended to represent a non-human user that needs to authenticate and be authorized to access data in Google APIs. If you don't have a service account, you must create a service account. For more information, see Creating a service account.

    • Enable the following services:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      To understand how to enable services, see Enabling services.

    If these services or permissions have not been enabled for your project previously, you are prompted to enable them when configuring the connector.

Configure the connector

Configuring the connector requires you to create a connection to your data source (backend system). A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following steps:

  1. In the Cloud console, go to the Integration Connectors > Connections page and then select or create a Google Cloud project.

    Go to the Connections page

  2. Click + CREATE NEW to open the Create Connection page.
  3. In the Location section, choose the location for the connection.
    1. Region: Select a location from the drop-down list.

      For the list of all the supported regions, see Locations.

    2. Click NEXT.
  4. In the Connection Details section, complete the following:
    1. Connector: Select Shopify from the drop down list of available Connectors.
    2. Connector version: Select the Connector version from the drop down list of available versions.
    3. In the Connection Name field, enter a name for the Connection instance.

      Connection names must meet the following criteria:

      • Connection names can use letters, numbers, or hyphens.
      • Letters must be lower-case.
      • Connection names must begin with a letter and end with a letter or number.
      • Connection names cannot exceed 49 characters.
    4. Optionally, enter a Description for the connection instance.
    5. Optionally, enable Cloud logging, and then select a log level. By default, the log level is set to Error.
    6. Service Account: Select a service account that has the required roles.
    7. Optionally, configure the Connection node settings:

      • Minimum number of nodes: Enter the minimum number of connection nodes.
      • Maximum number of nodes: Enter the maximum number of connection nodes.

      A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.

    8. App Id: AppId for the admin API.
    9. Max Points Per Call: Specifies how many points a call will cost.
    10. Schema: Specify the Shopify server version to connect with.
    11. Use proxy: Select this checkbox to configure a proxy server for the connection and configure the following values:
      • Proxy Auth Scheme: Select the authentication type to authenticate with the proxy server. The following authentication types are supported:
        • Basic: Basic HTTP authentication.
        • Digest: Digest HTTP authentication.
      • Proxy User: A user name to be used to authenticate with the proxy server.
      • Proxy Password: The Secret manager secret of the user's password.
      • Proxy SSL Type: The SSL type to use when connecting to the proxy server. The following authentication types are supported:
        • Auto: Default setting. If the URL is an HTTPS URL, then the Tunnel option is used. If the URL is an HTTP URL, then the NEVER option is used.
        • Always: The connection is always SSL enabled.
        • Never: The connection is not SSL enabled.
        • Tunnel: The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.
      • In the Proxy Server section, enter details of the proxy server.
        1. Click + Add destination.
        2. Select a Destination Type.
          • Host address: Specify the hostname or IP address of the destination.

            If you want to establish a private connection to your backend system, do the following:

    12. Optionally, click + ADD LABEL to add a label to the Connection in the form of a key/value pair.
    13. Click NEXT.
  5. In the Destinations section, enter details of the remote host (backend system) you want to connect to.
    1. Destination Type: Select a Destination Type.
      • Select Host address from the list to specify the hostname or IP address of the destination.
      • If you want to establish a private connection to your backend systems, select Endpoint attachment from the list, and then select the required endpoint attachment from the Endpoint Attachment list.

      If you want to establish a public connection to your backend systems with additional security, you can consider configuring static outbound IP addresses for your connections, and then configure your firewall rules to allowlist only the specific static IP addresses.

      To enter additional destinations, click +ADD DESTINATION.

    2. Click NEXT.
  6. In the Authentication section, enter the authentication details.
    1. The Shopify connection doesn't require any authentication.
    2. Click NEXT.
  7. Review: Review your connection and authentication details.
  8. Click Create.

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

  • Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

    However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

  • Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:

    Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

  • Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Entity operation examples

Example - List all products

This example lists all the records in the Products entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Products from the Entity list.
  3. Select the List operation, and then click Done.

Example - Get customer details

This example gets the details of the specified customer from the Customers entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Customers from the Entity list.
  3. Select the Get operation, and then click Done.
  4. Enter the entity ID of the customer whose details you want to fetch.

    In the Task Input section of the Connectors task, click entityId and then enter 365009521884E12 in the Default Value field.

Example - Delete an order record

This example deletes the specified order from the Order entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Order from the Entity list.
  3. Select the Delete operation, and then click Done.
  4. Enter the entity ID of the order that you want to delete.

    In the Task Input section of the Connectors task, click entityId and then enter 475009571483E15 in the Default Value field.

Example - Add a customer

This example adds the specified customer to the Customer entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Customer from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
"FirstName": "Test",
"LastName": "Customer5"
}

    Running this example, returns a response similar to the following in your connector task's connectorOutputPayload output variable:

    {
"Id": 6448083206296
}

Example - Create a record in DiscountCode

This example creates a new record in the DiscountCode entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select DiscountCode from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
"PriceRuleId": 1.394097291568E12,
"Code": "FREESHIP2025798"
}

    Running this example, returns a response similar to the following in your connector task's connectorOutputPayload output variable:

    {
"Id": 1.97836790828E13,
"PriceRuleId": null
}

Example - Create a record in Pricerule

This example creates a new record in the Pricerule entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Pricerule from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
"Id": 7.13459564696E11,
"AllocationMethod": "each",
"CustomerSelection": "all",
"TargetType": "line_item",
"UsageLimit": 100.0,
"Title": "DP_PriceRule"
}

    Running this example, returns a response similar to the following in your connector task's connectorOutputPayload output variable:

    {
"Id": 197836790834,
"PriceRuleId": null
}

Example - Create a record in ProductVariant

This example creates a new record in the ProductVariant entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select ProductVariant from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
"Id": 1070325065,
"ProductId": 7652181016728,
"ImageId": null,
"Price": 1,
"CompareAtPrice": null,
"Title": "Yellow",
"Barcode": null,
"FulfillmentService": "manual",
"InventoryManagement": "shopify",
"InventoryPolicy": "deny",
"InventoryQuantity": 1070325069,
"Option1": "Yellow",
"Option2": null,
"Option3": null,
"Position": 5,
"Sku": "",
"Taxable": true
}

    Running this example, returns a response similar to the following in your connector task's connectorOutputPayload output variable:

    {
"Id": 42711984373912
}

Example - Update customer details

This example updates the details of the specified customer in the Customer entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select Customer from the Entity list.
  3. Select the Update operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
"FirstName": "Test",
"LastName": "Customer2"
}
  5. Enter the entity ID of the customer that you want to delete.

    In the Task Input section of the Connectors task, click entityId and then enter 648400653532 in the Default Value field.

    Alternately, instead of specifying the entityId, you can also set the filterClause to 648400653532.

    Running this example, returns a response similar to the following in your connector task's connectorOutputPayload output variable:

    {
"Id": 648400653532
}

Example - Update a record in ProductVariant

This example updates a record in the ProductVariant entity.

  1. In the Configure connector task dialog, click Entities.
  2. Select ProductVariant from the Entity list.
  3. Select the Update operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
"ProductId": 7.652181016728E12,
"ImageId": null,
"Price": 200.0,
"CompareAtPrice": null,
"Title": "Yellow Updated",
"Barcode": null,
"FulfillmentService": "manual",
"InventoryManagement": "shopify",
"InventoryQuantity": 1.070325069E9,
"Option1": "Yellow new",
"Option2": null,
"Option3": null,
"Position": 5.0,
"Sku": "",
"Taxable": true
}
  5. Specify the entity ID of the record to update.

    To set the entity ID, click entityId and then enter 34601602744472 in the Default Value field.

    Running this example, returns a response similar to the following in your connector task's connectorOutputPayload output variable:

    {
"Id": 2484258073471
}

Use terraform to create connections

You can use the Terraform resource to create a new connection.

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands.

To view a sample terraform template for connection creation, see sample template.

When creating this connection by using Terraform, you must set the following variables in your Terraform configuration file:

Parameter name Data type Required Description
max_points_per_call STRING False Specifies how many points a call will cost.
schema_v23 ENUM False Specify the Shopify server version to connect with. Supported values are: REST-2023-04, REST-2023-07, GRAPHQL-2023-04, GRAPHQL-2023-07
proxy_enabled BOOLEAN False Select this checkbox to configure a proxy server for the connection.
proxy_auth_scheme ENUM False The authentication type to use to authenticate to the ProxyServer proxy. Supported values are: BASIC, DIGEST, NONE
proxy_user STRING False A user name to be used to authenticate to the ProxyServer proxy.
proxy_password SECRET False A password to be used to authenticate to the ProxyServer proxy.
proxy_ssltype ENUM False The SSL type to use when connecting to the ProxyServer proxy. Supported values are: AUTO, ALWAYS, NEVER, TUNNEL

Use the Shopify connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

  • To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
  • To understand how to create and use the Connectors task in Application Integration, see Connectors task.

Get help from the Google Cloud community

You can post your questions and discuss this connector in the Google Cloud community at Cloud Forums.

What's next