Docs
Sign in

WooCommerce connector

Updated May 26, 20263 min read

Use this connector to receive order webhooks from WooCommerce and send shipment status updates back. Order status stays in sync between both systems.

Capabilities

  • Draft shipment creation: automatically create draft shipments in Carriyo when an order is submitted in WooCommerce.
  • Shipment updates and cancellations: update or cancel shipments in Carriyo when an order is updated in WooCommerce.
  • Shipment fulfillment: fulfill shipments manually or automatically, based on merchant preferences.
  • Delivery and payment mapping: identify and map delivery types and payment methods (e.g. cash on delivery).
  • Product attribute mapping: identify and map product attributes such as country of origin and HS code for international shipments.

Setting up the connector

To set up the connector, create four webhooks and an API key in the WooCommerce admin, then enter the credentials in the Carriyo connector.

The steps are:

  • Set up the connector in Carriyo
  • Create the WooCommerce REST API key
  • Set up the webhooks
  • Configure the other settings

Set up the connector

1. In the Carriyo Dashboard, navigate to Integrations → Connectors. The page lists every supported connector and all existing connector instances. Click the WooCommerce connector to create a new instance.

2. Give the connector a name. Select the merchant that the WooCommerce store orders should belong to, and provide the website / storefront URL.

Create the WooCommerce REST API key

The REST API key consists of a consumer key and a consumer secret.

1. In the WooCommerce admin, navigate to WooCommerce → Settings → Advanced → REST API. Click Create an API key, give the key a name, set Permissions to Read/Write, and click Generate API key.

The key and the secret are generated.

2. Copy and paste the key and secret into the WooCommerce API Consumer Key and WooCommerce API Consumer Secret fields in the Carriyo connector setup page.

3. Click Save so the webhook details are displayed.

Set up the webhooks

Four webhooks are required. The details, including the delivery URL for each event, appear under the WooCommerce Webhook Setup section after you click View List of WooCommerce Webhooks to set up.

1. In WooCommerce, navigate to WooCommerce → Settings → Advanced → Webhooks. Click Add webhook (or Create a new webhook).

Fill in the fields:

  • Name: for example, on-order-created for the Order created event.
  • Status: Active.
  • Topic: select the corresponding topic from the dropdown (e.g. Order created).
  • Delivery URL: copy from the matching webhook in Carriyo.
  • Secret: copy from the WooCommerce webhook shared secret field on the Carriyo connector setup page. The same secret is used for every webhook.
  • API Version: WP REST API Integration v3.

Click Save webhook.

2. Repeat for the remaining three webhooks.

Other settings

Settings and options & allowed statuses

  • Auto confirm shipments: when on, Carriyo books orders automatically (via automation rules) when WooCommerce creates them. Otherwise, Carriyo creates shipments in Draft status.
  • Auto complete WooCommerce orders: tells WooCommerce that the order is complete based on the order or shipment status in Carriyo.
  • Allowed statuses for CoD: statuses the order can be updated to when the payment type is cash on delivery.
  • Allowed statuses for non-CoD: statuses the order can be updated to when the payment type is not cash on delivery.

Delivery types mapping & product attributes

  • Delivery types mapping: map WooCommerce delivery types to Carriyo delivery types. Set a default delivery type to apply when no mapping is found.
  • Product attributes: product attributes added in WooCommerce are forwarded in the webhooks sent to Carriyo.