This guide explains how to integrate a WooCommerce store with Carriyo.
Setting up WooCommerce integration requires creation of four webhooks and an API Key in the WooCommerce administrative settings. The Carriyo WooCommerce Connector setup page also includes some information that you will need to create the webhooks.
The key steps to follow are —
Additonal settings is explained under the Other Settings section.
Setting up the Connector
1. Navigate to the Connectors menu under Integrations in your Carriyo dashboard. The page displays all the connectors supported in Carriyo along with a list of all existing connectors. To create a new WooCommerce connector instance, click on the corresponding connector.
2. The initial step involves assigning a suitable name to the connector. Next, choose the specific merchant for which the store orders should be pushed through to Carriyo. Additionally, the website or e-commerce store front URL is to be provided. An example is given here.
Creating the WooCommerce REST API Key
This step involves creating a REST API key in WooCommerce which consists of a Consumer Key and a Consumer Secret.
1. Navigate to the WooCommerce Admin Dashboard at WooCommerce > Settings > Advanced > REST API. Clicking on the "Create an API key" button will display the key details to be filled. Name the key as desired and set permissions to Read/Write and click on the "Generate API key" button.
The key and the secret are generated.
2. Copy and paste both the key and the secret into the designated fields for WooCommerce API Consumer Key and WooCommerce API Consumer Secret fields in the Carriyo connector setup page.
3. The next step is to click on the Save button so that the webhook details are displayed.
Setting up the webhooks
Setting up the webhooks is a straightforward process. The details of the webhooks to be created will be present under the "WooCommerce Webhook Setup" section. A total of four webhooks will be displayed once the View List of WooCommerce Webhooks to set up is clicked.
1. Navigate to WooCommerce > Settings > Advanced > Webhooks. Click on the "Add webhook" or "Create a new webhook" button.
Fill in the fields as such — change the Name, Topic and Delivery URL accordingly.
- Name: on-order-created corresponding to the Event: Order created.
- Status: Active
- Topic: Order created (select from the dropdown)
- Delivery URL: Copy and paste the URL of the same webhook.
- Secret: This is to be copied from the WooCommerce webhook shared secret field from the Carriyo connector setup page.
- API Version: WP REST API Integration v3
Click on "Save webhook" and create a new one for each event.
2. Repeat the same process for all four webhooks in a similar fashion. The Secret is common to all webhooks.
Other settings
Settings and Options & Allowed Statuses
- Auto confirm shipments — when enabled, orders get automatically booked (with the help of automation rules) when they are created on WooCommerce. Else, it will be in draft status.
- Auto complete WooCommerce orders — notifies WooCommerce that the order has been completed based on the status of the order/shipment in Carriyo.
- Allowed statuses for CoD — The statuses that the order can be updated to when the payment type is Cash on Delivery.
- Allowed statuses for non-CoD — The statuses that the order can be updated to when the payment type is not Cash on Delivery.
Delivery Types Mapping & Product Attributes
- Delivery Types Mapping — The delivery types set up in WooCommerce can be mapped to the delivery types in Carriyo. Or a default delivery type can be chosen so that all orders created in WooCommerce will be of this type when it is sent to Carriyo.
- Product Attributes — These can be added in WooCommerce so that they will be passed in the webhooks sent to Carriyo.
Comments
0 comments
Please sign in to leave a comment.