WooCommerce

Use the WooCommerce connector to perform insert, delete, update, and read operations in WooCommerce.

Before you begin

Before using the WooCommerce connector, do the following tasks:

• In your Google Cloud project:
  • Ensure that network connectivity is set up. For information about network patterns, seeNetwork connectivity.
  • Grant theroles/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. The connector and the service account must belong to the same project. For more information, seeCreating a service account.

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

    To understand how to enable services, seeEnabling 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

A connection is specific to a data source. Itmeans that if you have many data sources, you must create a separate connectionfor each data source. To create a connection, do the following:

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

   Go to the Connections page

2. Click+ CREATE NEW to open theCreate Connection page.
3. In theLocation 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, seeLocations.

   2. ClickNEXT.
4. In theConnection Details section, complete the following:
   1. Connector: SelectWooCommerce 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 theConnection 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 aDescription for the connection instance.
   5. Optionally, enableCloud logging, and then select a log level. By default, the log level is set toError.
   6. Service Account: Select a service account that has therequired roles.
   7. Optionally, configure theConnection 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.

   Note: You can customize the connection node values only if you are a Pay-as-you-go customer.
   8. (Optional) In theAdvanced settings section, select theUse proxy 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 theProxy Server section, enter details of the proxy server.
     1. Click+ Add destination.
     2. Select aDestination 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:

          • Create aPSC service attachment.
          • Create anendpoint attachment and then enter the details of the endpoint attachment in theHost address field.
   9. Optionally, click+ ADD LABEL to add a label to the Connection in the form of a key/value pair.
   10. ClickNEXT.
5. In theDestinations section, enter details of the remote host (backend system) you want to connect to.
   1. Destination Type: Select aDestination Type.
      • To specify the destination hostname or IP address, selectHost address and enter the address in theHost 1 field.
      • To establish a private connection, selectHost Address and add the endpoint attachment created for the SAP Gateway using the HTTPS protocol.
      Note:To understand how to create an endpoint attachment, seePSC service attachment andendpoint attachment. After you have created the endpoint attachment, it will be visible in theEndpoint Attachment list.

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

   2. ClickNEXT.
6. In theAuthentication section, enter the authentication details.

   To understand how to configure these authentication types, seeConfigure authentication.

7. After you specify the authentication details, clickNEXT.
8. Review: Review your connection and authentication details.
9. ClickCreate.

Configure authentication

Enter the authentication details.

• Consumer Key: The consumer key assigned by WooCommerce when creating the authentication credentials.
• Consumer Secret: Secret Manager Secret containing the consumer secret associated with the connector.

System limitations

The Woocommerce connector can process 2 transactions per second, pernode,andthrottles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

For information on the limits applicable to Integration Connectors, seeLimits.

Note: The number ofIntegration Connectors nodes will autoscale dynamically based on your usage. However, if you want to reserve capacity for large volumes without waiting for autoscaling, you can adjust the minimum node value for a connection. More nodes are required to process more transactions for a connection. Conversely, fewer nodes are required if a connection processes fewer transactions. To configure the node values, do the following:

• If you are a pay-as-you-go customer, configure the minimum and maximum node value in the edit connection page.
• If you are a subscription based customer,contact support.

The maximum transactions that a node can handle depends on various factors. So, before adjusting the minimum nodes for better throughput, it is recommended you check if your backend systems are set up optimally to handle the required traffic.

Use the WooCommerce 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, seeConnectors task.
• To understand how to create and use the Connectors task in Application Integration, seeConnectors task.

Entities, operations, and actions

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

Note: You can view the entities, operations, and actions of a connector in theConnectors task.

• Entity:An entity can be thought of as an object, or a collection of properties, in theconnected 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 theEntities list will be empty.

• Operation:An operation is the activity that you can perform on an entity. You can performany of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

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

• Action:An action is a first class function that is made available to the integrationthrough 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 theActions list will be empty.

Note:All entities and actions will have a schema associated with them. For example, an action schema will have the parameter details such as; the parameternames, and its corresponding data type. The schema (metadata) for entities and actions is fetched by the connection atruntime from your backend. If there are any updates to the schema, such updates won't be automatically reflected in your existing connections; you must manually refresh the schema. To refreshthe schema for a connection, open theConnection details page of the connection, and then clickRefresh connection schema.

Actions

This section lists the actions supported by the connector. To understand how to configure the actions, seeAction examples.

Note: The results of all the actions will be available as aJSON response in theConnectors task'sconnectorOutputPayloadresponse parameter after you run your integration.

Update Shipping Zone Locations action

This action lets you Update the locations for a shipping zone in the Woocommerce.

Input parameters of the Update Shipping Zone Locations action

Parameter name	Data type	Required	Description
ZoneId	String	Yes	The ID of the zone to update.
Locations	String	Yes	The location details.

For example on how to configure theUpdate Shipping Zone Locations action, seeAction examples.

Action examples

This section describes how to perform some of the actions in this connector.

Example - Update Shipping Zone Locations

This example Update the locations for a shipping zone.

1. In theConfigure connector task dialog, clickActions.
2. Select theUpdate Shipping Zone Locations action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"ZoneId":"7","Locations":"[{\"code\":\"BR:SP\",\"type\":\"state\"}]"}

If the action is successful, theUpdate Shipping Zone Locations task'sconnectorOutputPayload response parameter will have a value similar to the following:

[{"code":"BR:SP","type":"state","_links_collection_href":"https://your-website.com/wp-json/wc/v3/shipping/zones/7/locations","_links_describes_href":"https://your-website.com/wp-json/wc/v3/shipping/zones/7","success":"true"}]

Entity operation examples

Example - List records of an entity

This example lists the records of anOrders entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectOrders from theEntity list.
3. Select theList operation, and then clickDone.
4. In theTask Input section of theConnectors task, you can set thefilterClause as per your requirement.

   For example, setting the filter clause toId='891', lists only those recordswhose order Id is 891.

Example - Get a single record from an entity

This example fetches a record from theOrders entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectOrders from theEntity list.
3. Select theGet operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickentityId andthen enter891 in theDefault Value field.

   Here,891 is an unique identifier for the resourceOrders entity.

Example - Delete a record from an entity

This example deletes a record from theOrders entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectOrders from theEntity list.
3. Select theDelete operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickentityId andthen enter891 in theDefault Value field.

   Alternately, if the entity has composite primary keys instead of specifying theentityId, you can set thefilterClause. For example,Id='891'.

Example - Create a record in an entity

This example creates a record in theOrders entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectOrders from theEntity list.
3. Select theCreate operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"BillingFirstName":"Alex","BillingLastName":"Smith","Status":"processing","CustomerId":1,"ShippingAddress1":"809/2 Downtown, Alaska, United States"}

If the integration is successful, the connector task'sconnectorOutputPayload field will have the response of the create operation.

{"Id":1010}

Example - Update a record in an entity

This example updates a record in theOrders entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectOrders from theEntity list.
3. Select theUpdate operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"Status":"on-hold"}

5. In theTask Input section of theConnectors task, clickentityId andthen enter1010 in theDefault Value field.

If the integration is successful, the connector task'sconnectorOutputPayload field will have the response of the update operation.

{"Id":1010}