# WooCommerce

* [1 Integrating Your WooCommerce Store With PrimeChat](#inlineextension-integrating-your-woocommerce-store-with-uchat)
* [2 Using WooCommerce Actions](#inlineextension-using-woocommerce-actions)
* [3 WooCommerce Native Actions](#inlineextension-woocommerce-native-actions)
  * [3.1 Add To Cart](#inlineextension-add-to-cart)
  * [3.2 Remove Cart By Variant](#inlineextension-remove-cart-by-variant)
  * [3.3 Remove Cart By Product](#inlineextension-remove-cart-by-product)
  * [3.4 Empty Cart](#inlineextension-empty-cart)
  * [3.5 Get Cart Items](#inlineextension-get-cart-items)
  * [3.6 Get Cart Item IDs and Quantity](#inlineextension-get-cart-item-ids-and-quantity)
  * [3.7 Create Order From Cart](#inlineextension-create-order-from-cart)
  * [3.8 Search For Coupons](#inlineextension-search-for-coupons)
  * [3.9 Get Coupon Info](#inlineextension-get-coupon-info)
  * [3.10 Delete Coupon](#inlineextension-delete-coupon)
  * [3.11 Create Coupon](#inlineextension-create-coupon)
  * [3.12 Update Coupon](#inlineextension-update-coupon)
  * [3.13 Search For Customers](#inlineextension-search-for-customers)
  * [3.14 Get Customer Info](#inlineextension-get-customer-info)
  * [3.15 Create Customer](#inlineextension-create-customer)
  * [3.16 Update Customer](#inlineextension-update-customer)
  * [3.17 Delete Customer](#inlineextension-delete-customer)
  * [3.18 Search For Orders](#inlineextension-search-for-orders)
  * [3.19 Get Order Info](#inlineextension-get-order-info)
  * [3.20 Create Order From Single Product](#inlineextension-create-order-from-single-product)
  * [3.21 Update Order](#inlineextension-update-order)
  * [3.22 Delete Order](#inlineextension-delete-order)
  * [3.23 Create Order Note](#inlineextension-create-order-note)
  * [3.24 Search For Products](#inlineextension-search-for-products)
  * [3.25 Get Product Info](#inlineextension-get-product-info)
  * [3.26 Create Product](#inlineextension-create-product)
  * [3.27 Update Product](#inlineextension-update-product)
  * [3.28 Delete Product](#inlineextension-delete-product)
  * [3.29 Search For Product Variants](#inlineextension-search-for-product-variants)
  * [3.30 Get Product Variant Info](#inlineextension-get-product-variant-info)
  * [3.31 Search For Categories](#inlineextension-search-for-categories)
  * [3.32 Get Category Info](#inlineextension-get-category-info)
  * [3.33 Get Product Tag Info](#inlineextension-get-product-tag-info)
  * [3.34 Create Product Tag](#inlineextension-create-product-tag)
  * [3.35 List All Shipping Methods](#inlineextension-list-all-shipping-methods)
  * [3.36 Create A Product Review](#inlineextension-create-a-product-review)
  * [3.37 Search Product Reviews](#inlineextension-search-product-reviews)
* [4 WooCommerce Native Triggers](#inlineextension-woocommerce-native-triggers)
  * [4.1 Order Creation](#inlineextension-order-creation)
  * [4.2 Order Update](#inlineextension-order-update)
  * [4.3 User Creation Using Triggers](#inlineextension-user-creation-using-triggers)

WooCommerce is an open-source e-commerce plugin for WordPress. It is designed for small to large-sized online merchants using WordPress. The plugin quickly became popular for its simplicity to install and customize and for the market position of the base product as freeware.

Woocommerce is now one of the leading options for online stores and for people who want to open there store online and fufill orders from it.

Primechat supports WooCommerce integration natively along with all the actions the current WooCommerce api supports in its endpoints.

You can not only create automations using Primechat for your WooCommerce store but also be able to create, edit, update orders, fullfill them, keep track of the orders, shipments , reviews etc.

### Integrating Your WooCommerce Store With Primechat <a href="#inlineextension-integrating-your-woocommerce-store-with-uchat" id="inlineextension-integrating-your-woocommerce-store-with-uchat"></a>

In order to integrate Primechat with your WooCommerce store, you need to log in to your store and click on WooCommerce Tab.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2Fy7nAR4OtbNe3C8DxblCg%2FWoocomerce%20chatbot%20integration01.png?alt=media&#x26;token=b7850b82-e0c0-4d0b-94c9-13a3d2748bec" alt=""><figcaption></figcaption></figure>

Click on Settings > Advanced > REST API tab

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FQ0y4BUmEMnkFEtvZ9v1W%2FWoocomerce%20chatbot%20integration02.png?alt=media&#x26;token=2a44af5b-1de6-4a44-9b95-87af2b117638" alt=""><figcaption></figcaption></figure>

Click on Add Key

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FP2PCPky1UOu2x9dFeZ6p%2FWoocomerce%20chatbot%20integration03.png?alt=media&#x26;token=123e8e04-dfb9-4af1-a37b-e361f1abd9c6" alt=""><figcaption></figcaption></figure>

Enter the details and create your API Key.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2F1xJpqx9MsEsoRZ06xqPA%2FWoocomerce%20chatbot%20integration04.png?alt=media&#x26;token=0369af91-e3ae-452d-bb2f-4e66104e8b26" alt=""><figcaption></figcaption></figure>

Save and copy the details.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2Fa1SpOdkg0y9wwLKRl3to%2FWoocomerce%20chatbot%20integration05.png?alt=media&#x26;token=0aa7b1b8-df00-4977-a54d-b96e9d9dc341" alt=""><figcaption></figcaption></figure>

On Primechat, Click on the Integrations tab and click on WooCommerce to integrate your store.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FLMpuyfTgpX0wlIfgYLIc%2FWoocomerce%20chatbot%20integration06.png?alt=media&#x26;token=6667cbf5-d838-437b-a5c8-46852449561e" alt=""><figcaption></figcaption></figure>

### Using WooCommerce Actions <a href="#inlineextension-using-woocommerce-actions" id="inlineextension-using-woocommerce-actions"></a>

To use WooCommerce actions, create an action node and then click on integrations to find WooCommerce tab and click on it.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FLdBdPFCFDaRiM9oVGlz2%2FWoocomerce%20chatbot%20integration07.png?alt=media&#x26;token=1eff6cea-2460-46ce-af1f-163ad4e11454" alt=""><figcaption></figcaption></figure>

### WooCommerce Native Actions <a href="#inlineextension-woocommerce-native-actions" id="inlineextension-woocommerce-native-actions"></a>

WooCommerce supports the following actions from their API endpoints as follows.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FLjlusuCD9TLJnhzWeO2q%2FWoocomerce%20chatbot%20integration08.png?alt=media&#x26;token=4b8d4156-1d06-495c-8927-5ce80aabe883" alt=""><figcaption></figcaption></figure>

<div><figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FP9OBQuYvdIpS1RyCRMcm%2FWoocomerce%20chatbot%20integration09.png?alt=media&#x26;token=bc7ec436-e110-469e-b68e-9fd44c3366f8" alt=""><figcaption></figcaption></figure> <figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FYcF2WTrD01CVb0YP7EUi%2FWoocomerce%20chatbot%20integration10.png?alt=media&#x26;token=b04d0290-0f54-47fd-9e37-8342c5b1303e" alt=""><figcaption></figcaption></figure> <figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FQL75AV6nGyjsK8Rz67Q7%2FWoocomerce%20chatbot%20integration11.png?alt=media&#x26;token=b454c845-97e5-45c7-888e-6539f65065ab" alt=""><figcaption></figcaption></figure> <figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FEfbWqcBR7bQWc6VnAquX%2FWoocomerce%20chatbot%20integration12.png?alt=media&#x26;token=9ee8e097-9297-49a0-a2c1-7251e92e6b7c" alt=""><figcaption></figcaption></figure> <figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FviYrlLwpOPky3qlh8UJP%2FWoocomerce%20chatbot%20integration13.png?alt=media&#x26;token=84321f10-44c2-4dcc-962a-2e7007bb6e96" alt=""><figcaption></figcaption></figure></div>

We will now explore each one of cards above in detail.

#### Add To Cart <a href="#inlineextension-add-to-cart" id="inlineextension-add-to-cart"></a>

This action is used to add an item or product to the user’s cart.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FNPhLViICn5y7jfQ9pJb3%2FWoocomerce%20chatbot%20integration14.png?alt=media&#x26;token=5b38c835-32d1-4284-91f1-c843817ab5c7" alt=""><figcaption></figcaption></figure>

Following response payload is received

| <p>{<br>"variant\_id": 4120,<br>"product\_id": 375,<br>"quantity": 1,<br>"previous\_quantity": 0<br>}</p> |
| --------------------------------------------------------------------------------------------------------- |

#### Remove Cart By Variant <a href="#inlineextension-remove-cart-by-variant" id="inlineextension-remove-cart-by-variant"></a>

This action is used to remove an item or product from cart using its variant and product ID.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2Ff09Os9yahXjPuHIglOeB%2FWoocomerce%20chatbot%20integration15.png?alt=media&#x26;token=188dab17-7fc3-40d1-af1f-15f28b40e574" alt=""><figcaption></figcaption></figure>

Following response, payload is received.

| <p>{<br>"variant\_id": 4120,<br>"product\_id": 375,<br>"quantity": 1,<br>"previous\_quantity": 3<br>}</p> |
| --------------------------------------------------------------------------------------------------------- |

#### Remove Cart By Product <a href="#inlineextension-remove-cart-by-product" id="inlineextension-remove-cart-by-product"></a>

This action is used to remove an item or product from cart using product ID only.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FfkHDHph9tPRYehMIyVwJ%2FWoocomerce%20chatbot%20integration16.png?alt=media&#x26;token=f45e2c73-ad85-4029-b517-0164f4a91d71" alt=""><figcaption></figcaption></figure>

Following response, payload is received.

| <p>{<br>"product\_id": 375,<br>"removed\_variants": \[<br>{<br>"variant\_id": 4120,<br>"quantity": 1<br>}<br>]<br>}</p> |
| ----------------------------------------------------------------------------------------------------------------------- |

#### Empty Cart <a href="#inlineextension-empty-cart" id="inlineextension-empty-cart"></a>

This action is used to empty the complete cart.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FHjC6In4oIrL6BeX6enOZ%2FWoocomerce%20chatbot%20integration17.png?alt=media&#x26;token=32e75aa6-1b26-40fd-b257-f8fd80568092" alt=""><figcaption></figcaption></figure>

Following response payload is received.

#### Get Cart Items <a href="#inlineextension-get-cart-items" id="inlineextension-get-cart-items"></a>

This action is used to fetch all the details for items present in the cart

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2F8RUILLIXttwSVx2SBWBN%2FWoocomerce%20chatbot%20integration18.png?alt=media&#x26;token=076697b1-80d4-4507-9949-5e8e61dd8929" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>\[<br>{<br>"id": 258,<br>"name": "DNK Black Shoes - blue",<br>"product\_id": 375,<br>"variation\_id": 4120,<br>"quantity": 2,<br>"subtotal": "350.00",<br>"subtotal\_tax": "0.00",<br>"total": "350.00",<br>"total\_tax": "0.00",<br>"sku": "",<br>"price": 175,<br>"image": "<https://shop.business.io/wp-content/uploads/2021/03/sports-shoe5.jpg>",<br>"parent\_name": "DNK Black Shoes"<br>}<br>]</p> |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

#### Get Cart Item IDs and Quantity <a href="#inlineextension-get-cart-item-ids-and-quantity" id="inlineextension-get-cart-item-ids-and-quantity"></a>

This action is used to get an item’s IDs and quantity which are present in the cart.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FB1ac2lv6yC6WRLgcSAhz%2FWoocomerce%20chatbot%20integration19.png?alt=media&#x26;token=2340a4de-e5a6-46bb-bdb1-8bc70c5eaa32" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>\[<br>{<br>"product\_id": 375,<br>"quantity": 2,<br>"variation\_id": 4120<br>}<br>]</p> |
| ------------------------------------------------------------------------------------------ |

#### Create Order From Cart <a href="#inlineextension-create-order-from-cart" id="inlineextension-create-order-from-cart"></a>

This action is used to create an order using cart items.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FtHexMunnkSlNET21BQNR%2FWoocomerce%20chatbot%20integration20.png?alt=media&#x26;token=be033dcf-06e0-47d7-a9a6-55ff9844e970" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 4597,<br>"parent\_id": 0,<br>"status": "pending",<br>"currency": "AUD",<br>"version": "6.9.4",<br>"prices\_include\_tax": false,<br>"date\_created": "2023-04-14T11:01:51",<br>"date\_modified": "2023-04-14T11:01:51",<br>"discount\_total": "0.00",<br>"discount\_tax": "0.00",<br>"shipping\_total": "0.00",<br>"shipping\_tax": "0.00",<br>"cart\_tax": "0.00",<br>"total": "350.00",<br>"total\_tax": "0.00",<br>"customer\_id": 0,<br>"order\_key": "wc\_order\_5hKQmDkxUiesi",<br>"billing": {<br>"first\_name": "XXXX",<br>"last\_name": "XXXXXXX",<br>"company": "",<br>"address\_1": "ABC Road, Garden City",<br>"address\_2": "",<br>"city": "Karachi",<br>"state": "Sindh",<br>"postcode": "",<br>"country": "Pakistan",<br>"email": "<test@gmail.com>",<br>"phone": "+444444"<br>},<br>"shipping": {<br>"first\_name": "Hammad",<br>"last\_name": "Siddiqui",<br>"company": "",<br>"address\_1": "ABC Road, Garden City",<br>"address\_2": "",<br>"city": "Karachi",<br>"state": "Sindh",<br>"postcode": "",<br>"country": "Pakistan",<br>"phone": ""<br>},<br>"payment\_method": "",<br>"payment\_method\_title": "",<br>"transaction\_id": "",<br>"customer\_ip\_address": "",<br>"customer\_user\_agent": "",<br>"created\_via": "rest-api",<br>"customer\_note": "",<br>"date\_completed": null,<br>"date\_paid": null,<br>"cart\_hash": "",<br>"number": "4597",<br>"meta\_data": \[<br>{<br>"id": 6465,<br>"key": "user\_ns",<br>"value": "f12372u15376836"<br>}<br>],<br>"line\_items": \[<br>{<br>"id": 259,<br>"name": "DNK Black Shoes - blue",<br>"product\_id": 375,<br>"variation\_id": 4120,<br>"quantity": 2,<br>"tax\_class": "",<br>"subtotal": "350.00",<br>"subtotal\_tax": "0.00",<br>"total": "350.00",<br>"total\_tax": "0.00",<br>"taxes": \[...], // 0 items<br>"meta\_data": \[...], // 1 items<br>"sku": "",<br>"price": 175,<br>"image": {...}, // 2 keys<br>"parent\_name": "DNK Black Shoes"<br>}<br>],<br>"tax\_lines": \[<br>],<br>"shipping\_lines": \[<br>],<br>"fee\_lines": \[<br>],<br>"coupon\_lines": \[<br>],<br>"refunds": \[<br>],<br>"payment\_url": "<https://shop.business.io/checkout-2/order-pay/4597?pay_for_order=true&#x26;key=wc_order_5hKQmDkxUiesi>",<br>"is\_editable": true,<br>"needs\_payment": true,<br>"needs\_processing": true,<br>"date\_created\_gmt": "2023-04-14T11:01:51",<br>"date\_modified\_gmt": "2023-04-14T11:01:51",<br>"date\_completed\_gmt": null,<br>"date\_paid\_gmt": null,<br>"currency\_symbol": "$"<br>}</p> |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

#### Search For Coupons <a href="#inlineextension-search-for-coupons" id="inlineextension-search-for-coupons"></a>

This action is used to search for coupons available on your Woocommerce store on various search parameters and queries.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2Fo9UsxPWCCJwnC0nTXs3c%2FWoocomerce%20chatbot%20integration22.png?alt=media&#x26;token=02ead1a2-84b3-4f7c-9936-fd2517f02099" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>\[<br>{<br>"id": 4592,<br>"code": "vipdiscount60fc",<br>"amount": "10.00",<br>"status": "publish",<br>"date\_created": "2023-01-25T06:56:57",<br>"date\_created\_gmt": "2023-01-25T06:56:57",<br>"date\_modified": "2023-01-25T06:56:57",<br>"date\_modified\_gmt": "2023-01-25T06:56:57",<br>"discount\_type": "percent",<br>"description": "10% discount on entire order, single use",<br>"date\_expires": null,<br>"date\_expires\_gmt": null,<br>"usage\_count": 1,<br>"individual\_use": false,<br>"product\_ids": \[<br>],<br>"excluded\_product\_ids": \[<br>],<br>"usage\_limit": 1,<br>"usage\_limit\_per\_user": 1,<br>"limit\_usage\_to\_x\_items": null,<br>"free\_shipping": false,<br>"product\_categories": \[<br>],<br>"excluded\_product\_categories": \[<br>],<br>"exclude\_sale\_items": false,<br>"minimum\_amount": "0.00",<br>"maximum\_amount": "0.00",<br>"email\_restrictions": \[<br>],<br>"used\_by": \[<br>"<test@doe.com>"<br>],<br>"meta\_data": \[<br>],<br>"\_links": {<br>"self": \[...], // 1 items<br>"collection": \[...] // 1 items<br>}<br>}<br>]</p> |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Get Coupon Info <a href="#inlineextension-get-coupon-info" id="inlineextension-get-coupon-info"></a>

This action is used to fetch a particular coupon’s info using its coupon ID.

Following response payload is received.

| <p>{<br>"id": 4592,<br>"code": "vipdiscount60fc",<br>"amount": "10.00",<br>"status": "publish",<br>"date\_created": "2023-01-25T06:56:57",<br>"date\_created\_gmt": "2023-01-25T06:56:57",<br>"date\_modified": "2023-01-25T06:56:57",<br>"date\_modified\_gmt": "2023-01-25T06:56:57",<br>"discount\_type": "percent",<br>"description": "10% discount on entire order, single use",<br>"date\_expires": null,<br>"date\_expires\_gmt": null,<br>"usage\_count": 1,<br>"individual\_use": false,<br>"product\_ids": \[<br>],<br>"excluded\_product\_ids": \[<br>],<br>"usage\_limit": 1,<br>"usage\_limit\_per\_user": 1,<br>"limit\_usage\_to\_x\_items": null,<br>"free\_shipping": false,<br>"product\_categories": \[<br>],<br>"excluded\_product\_categories": \[<br>],<br>"exclude\_sale\_items": false,<br>"minimum\_amount": "0.00",<br>"maximum\_amount": "0.00",<br>"email\_restrictions": \[<br>],<br>"used\_by": \[<br>"<test@doe.com>"<br>],<br>"meta\_data": \[<br>]<br>}</p> |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Delete Coupon <a href="#inlineextension-delete-coupon" id="inlineextension-delete-coupon"></a>

This action is used to delete a coupon based on its coupon ID.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2Fv6keyAJhvELdt1mkJwSU%2FWoocomerce%20chatbot%20integration23.png?alt=media&#x26;token=901bc0c1-2ad0-4b42-b2da-c45afdea05cc" alt=""><figcaption></figcaption></figure>

Following response payload is received.

&#x20;

| <p>{<br>"status": "ok"<br>}</p> |
| ------------------------------- |

&#x20;

#### Create Coupon <a href="#inlineextension-create-coupon" id="inlineextension-create-coupon"></a>

This action is used to create a coupon.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FFyJ41pZKOrRuChyuKtCo%2FWoocomerce%20chatbot%20integration25.png?alt=media&#x26;token=276787bd-d1b2-4d58-9ea1-aa58febfad5e" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FhRVXcYZ6Q4kUGD4hdRZ2%2FWoocomerce%20chatbot%20integration26.png?alt=media&#x26;token=3289d5c3-1c96-4329-8ade-61b94bcf35ef" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 4598,<br>"code": "test12",<br>"amount": "10.00",<br>"status": "publish",<br>"date\_created": "2023-04-14T14:27:49",<br>"date\_created\_gmt": "2023-04-14T14:27:49",<br>"date\_modified": "2023-04-14T14:27:49",<br>"date\_modified\_gmt": "2023-04-14T14:27:49",<br>"discount\_type": "percent",<br>"description": "test coupon",<br>"date\_expires": "2023-05-01T00:00:00",<br>"date\_expires\_gmt": "2023-05-01T00:00:00",<br>"usage\_count": 0,<br>"individual\_use": false,<br>"product\_ids": \[<br>],<br>"excluded\_product\_ids": \[<br>],<br>"usage\_limit": 1,<br>"usage\_limit\_per\_user": 1,<br>"limit\_usage\_to\_x\_items": null,<br>"free\_shipping": false,<br>"product\_categories": \[<br>],<br>"excluded\_product\_categories": \[<br>],<br>"exclude\_sale\_items": false,<br>"minimum\_amount": "0.00",<br>"maximum\_amount": "0.00",<br>"email\_restrictions": \[<br>],<br>"used\_by": \[<br>],<br>"meta\_data": \[<br>]<br>}</p> |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Update Coupon <a href="#inlineextension-update-coupon" id="inlineextension-update-coupon"></a>

This action is used to update a coupon using its coupon ID.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2Fml5Pp6fhX2ZqOAG90nvi%2FWoocomerce%20chatbot%20integration27.png?alt=media&#x26;token=34bf5e02-f92d-4a4c-a6f7-530045b814b9" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 4598,<br>"code": "test12",<br>"amount": "15.00",<br>"status": "publish",<br>"date\_created": "2023-04-14T14:27:49",<br>"date\_created\_gmt": "2023-04-14T14:27:49",<br>"date\_modified": "2023-04-14T14:27:49",<br>"date\_modified\_gmt": "2023-04-14T14:27:49",<br>"discount\_type": "percent",<br>"description": "test coupon",<br>"date\_expires": "2023-05-01T00:00:00",<br>"date\_expires\_gmt": "2023-05-01T00:00:00",<br>"usage\_count": 0,<br>"individual\_use": false,<br>"product\_ids": \[<br>],<br>"excluded\_product\_ids": \[<br>],<br>"usage\_limit": 3,<br>"usage\_limit\_per\_user": 1,<br>"limit\_usage\_to\_x\_items": null,<br>"free\_shipping": false,<br>"product\_categories": \[<br>],<br>"excluded\_product\_categories": \[<br>],<br>"exclude\_sale\_items": false,<br>"minimum\_amount": "0.00",<br>"maximum\_amount": "0.00",<br>"email\_restrictions": \[<br>],<br>"used\_by": \[<br>],<br>"meta\_data": \[<br>]<br>}</p> |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Search For Customers <a href="#inlineextension-search-for-customers" id="inlineextension-search-for-customers"></a>

This action is used to search for customers using various parameters and queries.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2F4UFSaMbGXb06cGTkgLUl%2FWoocomerce%20chatbot%20integration28.png?alt=media&#x26;token=5366599c-b767-4b91-a6ff-49e787e9b824" alt=""><figcaption></figcaption></figure>

Following response payload was received.

| <p>\[<br>{<br>"id": 2,<br>"date\_created": "2022-10-10T01:24:22",<br>"date\_created\_gmt": "2022-10-10T01:24:22",<br>"date\_modified": "2022-10-10T01:24:22",<br>"date\_modified\_gmt": "2022-10-10T01:24:22",<br>"email": "<test@test.com>",<br>"first\_name": "",<br>"last\_name": "last",<br>"role": "customer",<br>"username": "test",<br>"billing": {<br>"first\_name": "",<br>"last\_name": "",<br>"company": "",<br>"address\_1": "",<br>"address\_2": "",<br>"city": "",<br>"postcode": "",<br>"country": "",<br>"state": "",<br>"email": "",<br>"phone": ""<br>},<br>"shipping": {<br>"first\_name": "",<br>"last\_name": "",<br>"company": "",<br>"address\_1": "",<br>"address\_2": "",<br>"city": "",<br>"postcode": "",<br>"country": "",<br>"state": "",<br>"phone": ""<br>},<br>"is\_paying\_customer": false,<br>"avatar\_url": "<https://secure.gravatar.com/avatar/b642b4217b34b1e8d3bd915fc65c4452?s=96&d=mm&r=g>",<br>"meta\_data": \[<br>{...} // 3 keys<br>],<br>"\_links": {<br>"self": \[...], // 1 items<br>"collection": \[...] // 1 items<br>}<br>},<br>{<br>"id": 5,<br>"date\_created": "2022-10-12T16:32:26",<br>"date\_created\_gmt": "2022-10-12T16:32:26",<br>"date\_modified": "2022-10-12T16:32:26",<br>"date\_modified\_gmt": "2022-10-12T16:32:26",<br>"email": "<hello@primechat.ai>",<br>"first\_name": "test",<br>"last\_name": "test",<br>"role": "customer",<br>"username": "test",<br>"billing": {<br>"first\_name": "test",<br>"last\_name": "test",<br>"company": "",<br>"address\_1": "palmonostora 143",<br>"address\_2": "",<br>"city": "Palmonostora",<br>"postcode": "6112",<br>"country": "Hungary",<br>"state": "bacs-kiskun",<br>"email": "<hello@primechat.ai>",<br>"phone": "+36707203759"<br>},<br>"shipping": {<br>"first\_name": "test",<br>"last\_name": "test",<br>"company": "",<br>"address\_1": "palmonostora 143",<br>"address\_2": "",<br>"city": "Palmonostora",<br>"postcode": "6112",<br>"country": "Hungary",<br>"state": "bacs-kiskun",<br>"phone": ""<br>},<br>"is\_paying\_customer": false,<br>"avatar\_url": "<https://secure.gravatar.com/avatar/f96de5c9ef467d55b706b615b56a641b?s=96&d=mm&r=g>",<br>"meta\_data": \[<br>],<br>"\_links": {<br>"self": \[...], // 1 items<br>"collection": \[...] // 1 items<br>}<br>}<br>]</p> |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Get Customer Info <a href="#inlineextension-get-customer-info" id="inlineextension-get-customer-info"></a>

This action is used to fetch information for a customer using their customer ID.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FgT0vPVCQMDVZjvVMclmc%2FWoocomerce%20chatbot%20integration29.png?alt=media&#x26;token=a31bdff6-98c2-402a-98be-27dd6d5909e0" alt=""><figcaption></figcaption></figure>

| <p>{<br>"id": 2,<br>"date\_created": "2022-10-10T01:24:22",<br>"date\_created\_gmt": "2022-10-10T01:24:22",<br>"date\_modified": "2022-10-10T01:24:22",<br>"date\_modified\_gmt": "2022-10-10T01:24:22",<br>"email": "<test@test.com>",<br>"first\_name": "",<br>"last\_name": "last",<br>"role": "customer",<br>"username": "test",<br>"billing": {<br>"first\_name": "",<br>"last\_name": "",<br>"company": "",<br>"address\_1": "",<br>"address\_2": "",<br>"city": "",<br>"postcode": "",<br>"country": "",<br>"state": "",<br>"email": "",<br>"phone": ""<br>},<br>"shipping": {<br>"first\_name": "",<br>"last\_name": "",<br>"company": "",<br>"address\_1": "",<br>"address\_2": "",<br>"city": "",<br>"postcode": "",<br>"country": "",<br>"state": "",<br>"phone": ""<br>},<br>"is\_paying\_customer": false,<br>"avatar\_url": "<https://secure.gravatar.com/avatar/b642b4217b34b1e8d3bd915fc65c4452?s=96&#x26;d=mm&#x26;r=g>",<br>"meta\_data": \[<br>{<br>"id": 62,<br>"key": "wc\_last\_active",<br>"value": "1665532800"<br>}<br>]<br>}</p> |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Create Customer <a href="#inlineextension-create-customer" id="inlineextension-create-customer"></a>

This action is used to create a customer.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FSLcgMY4eyLMOpS4skCDe%2FWoocomerce%20chatbot%20integration30.png?alt=media&#x26;token=faf06cad-39d1-49b9-9542-e0d7b632b852" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 6,<br>"date\_created": "2023-04-14T17:54:14",<br>"date\_created\_gmt": "2023-04-14T17:54:14",<br>"date\_modified": "2023-04-14T17:54:14",<br>"date\_modified\_gmt": "2023-04-14T17:54:14",<br>"email": "<test@gmail.com>",<br>"first\_name": "test",<br>"last\_name": "test",<br>"role": "customer",<br>"username": "test",<br>"billing": {<br>"first\_name": "Hammad",<br>"last\_name": "Siddiqui",<br>"company": "",<br>"address\_1": "abc road , garden city",<br>"address\_2": "Maymar, Karachi",<br>"city": "Karachi",<br>"postcode": "78601",<br>"country": "Pakistan",<br>"state": "Sindh",<br>"email": "<test@gmail.com>",<br>"phone": "+444444"<br>},<br>"shipping": {<br>"first\_name": "Hammad",<br>"last\_name": "Siddiqui",<br>"company": "",<br>"address\_1": "abc road , garden city",<br>"address\_2": "Maymar, Karachi",<br>"city": "Karachi",<br>"postcode": "78601",<br>"country": "Pakistan",<br>"state": "Sindh",<br>"phone": ""<br>},<br>"is\_paying\_customer": false,<br>"avatar\_url": "<https://secure.gravatar.com/avatar/f4c6265a08a9578979e81cc594810336?s=96&#x26;d=mm&#x26;r=g>",<br>"meta\_data": \[<br>]<br>}</p> |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Update Customer <a href="#inlineextension-update-customer" id="inlineextension-update-customer"></a>

This action is used to update the details of a customer using their customer ID.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FrbIiiiN4uPbiihXgtkRY%2FWoocomerce%20chatbot%20integration31.png?alt=media&#x26;token=760d5a96-85ec-436c-8eff-7ead0070d322" alt=""><figcaption></figcaption></figure>

Once created, the username and password for the customer cannot be changed by the admin.

Following response payload is received.

| <p>{<br>"id": 6,<br>"date\_created": "2023-04-14T17:54:14",<br>"date\_created\_gmt": "2023-04-14T17:54:14",<br>"date\_modified": "2023-04-14T17:57:24",<br>"date\_modified\_gmt": "2023-04-14T17:57:24",<br>"email": "<test@gmail.com>",<br>"first\_name": "test",<br>"last\_name": "test",<br>"role": "customer",<br>"username": "test",<br>"billing": {<br>"first\_name": "Hammad",<br>"last\_name": "Siddiqui",<br>"company": "",<br>"address\_1": "abc road , garden city",<br>"address\_2": "Maymar, Karachi",<br>"city": "Karachi",<br>"postcode": "78601",<br>"country": "Pakistan",<br>"state": "Sindh",<br>"email": "<test@gmail.com>",<br>"phone": "+444444"<br>},<br>"shipping": {<br>"first\_name": "Hammad",<br>"last\_name": "Siddiqui",<br>"company": "",<br>"address\_1": "abc road , garden city",<br>"address\_2": "Maymar, Karachi",<br>"city": "Karachi",<br>"postcode": "78601",<br>"country": "Pakistan",<br>"state": "Sindh",<br>"phone": ""<br>},<br>"is\_paying\_customer": false,<br>"avatar\_url": "<https://secure.gravatar.com/avatar/f4c6265a08a9578979e81cc594810336?s=96&#x26;d=mm&#x26;r=g>",<br>"meta\_data": \[<br>]<br>}</p> |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Delete Customer <a href="#inlineextension-delete-customer" id="inlineextension-delete-customer"></a>

This action is used to delete a particular customer using their customer ID.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FwfFEbni4fSsMsSWK2Qgq%2FWoocomerce%20chatbot%20integration33.png?alt=media&#x26;token=2e325aa7-3e68-496f-8f79-25327b5bdd60" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 2,<br>"date\_created": "2022-10-10T01:24:22",<br>"date\_created\_gmt": "2022-10-10T01:24:22",<br>"date\_modified": "2022-10-10T01:24:22",<br>"date\_modified\_gmt": "2022-10-10T01:24:22",<br>"email": "<test@test.com>",<br>"first\_name": "",<br>"last\_name": "last",<br>"role": "customer",<br>"username": "test",<br>"billing": {<br>"first\_name": "",<br>"last\_name": "",<br>"company": "",<br>"address\_1": "",<br>"address\_2": "",<br>"city": "",<br>"postcode": "",<br>"country": "",<br>"state": "",<br>"email": "",<br>"phone": ""<br>},<br>"shipping": {<br>"first\_name": "",<br>"last\_name": "",<br>"company": "",<br>"address\_1": "",<br>"address\_2": "",<br>"city": "",<br>"postcode": "",<br>"country": "",<br>"state": "",<br>"phone": ""<br>},<br>"is\_paying\_customer": false,<br>"avatar\_url": "<https://secure.gravatar.com/avatar/b642b4217b34b1e8d3bd915fc65c4452?s=96&#x26;d=mm&#x26;r=g>",<br>"meta\_data": \[<br>{<br>"id": 62,<br>"key": "wc\_last\_active",<br>"value": "1665532800"<br>}<br>]<br>}</p> |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Search For Orders <a href="#inlineextension-search-for-orders" id="inlineextension-search-for-orders"></a>

This action is used to search for orders using various parameters and queries.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FLhNdiLnF1Vkb0SsWGLhS%2FWoocomerce%20chatbot%20integration34.png?alt=media&#x26;token=030ec78f-5d6f-4a61-bed1-865a081672db" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>\[<br>{<br>"id": 4597,<br>"parent\_id": 0,<br>"status": "pending",<br>"currency": "AUD",<br>"version": "6.9.4",<br>"prices\_include\_tax": false,<br>"date\_created": "2023-04-14T11:01:51",<br>"date\_modified": "2023-04-14T11:01:51",<br>"discount\_total": "0.00",<br>"discount\_tax": "0.00",<br>"shipping\_total": "0.00",<br>"shipping\_tax": "0.00",<br>"cart\_tax": "0.00",<br>"total": "350.00",<br>"total\_tax": "0.00",<br>"customer\_id": 0,<br>"order\_key": "wc\_order\_5hKQmDkxUiesi",<br>"billing": {<br>"first\_name": "Hammad",<br>"last\_name": "Siddiqui",<br>"company": "",<br>"address\_1": "ABC Road, Garden City",<br>"address\_2": "",<br>"city": "Karachi",<br>"state": "Sindh",<br>"postcode": "",<br>"country": "Pakistan",<br>"email": "<test@gmail.com>",<br>"phone": "+4444"<br>},<br>"shipping": {<br>"first\_name": "test",<br>"last\_name": "test",<br>"company": "",<br>"address\_1": "ABC Road, Garden City",<br>"address\_2": "",<br>"city": "Karachi",<br>"state": "Sindh",<br>"postcode": "",<br>"country": "Pakistan",<br>"phone": ""<br>},<br>"payment\_method": "",<br>"payment\_method\_title": "",<br>"transaction\_id": "",<br>"customer\_ip\_address": "",<br>"customer\_user\_agent": "",<br>"created\_via": "rest-api",<br>"customer\_note": "",<br>"date\_completed": null,<br>"date\_paid": null,<br>"cart\_hash": "",<br>"number": "4597",<br>"meta\_data": \[<br>{...} // 3 keys<br>],<br>"line\_items": \[<br>{...} // 16 keys<br>],<br>"tax\_lines": \[<br>],<br>"shipping\_lines": \[<br>],<br>"fee\_lines": \[<br>],<br>"coupon\_lines": \[<br>],<br>"refunds": \[<br>],<br>"payment\_url": "<https://shop.xxxxx.io/checkout-2/order-pay/4597?pay_for_order=true&key=wc_order_5hKQmDkxUiesi>",<br>"is\_editable": true,<br>"needs\_payment": true,<br>"needs\_processing": true,<br>"date\_created\_gmt": "2023-04-14T11:01:51",<br>"date\_modified\_gmt": "2023-04-14T11:01:51",<br>"date\_completed\_gmt": null,<br>"date\_paid\_gmt": null,<br>"currency\_symbol": "$",<br>"\_links": {<br>"self": \[...], // 1 items<br>"collection": \[...] // 1 items<br>}<br>}<br>]</p> |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

#### Get Order Info <a href="#inlineextension-get-order-info" id="inlineextension-get-order-info"></a>

This action is used to fetch order information using order ID.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FRbUT2mdS2JFojb0z5oPL%2FWoocomerce%20chatbot%20integration35.png?alt=media&#x26;token=9bc33365-ebc7-43dd-bb2e-2e431e4dad68" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 4597,<br>"parent\_id": 0,<br>"status": "pending",<br>"currency": "AUD",<br>"version": "6.9.4",<br>"prices\_include\_tax": false,<br>"date\_created": "2023-04-14T11:01:51",<br>"date\_modified": "2023-04-14T11:01:51",<br>"discount\_total": "0.00",<br>"discount\_tax": "0.00",<br>"shipping\_total": "0.00",<br>"shipping\_tax": "0.00",<br>"cart\_tax": "0.00",<br>"total": "350.00",<br>"total\_tax": "0.00",<br>"customer\_id": 0,<br>"order\_key": "wc\_order\_5hKQmDkxUiesi",<br>"billing": {<br>"first\_name": "Hammad",<br>"last\_name": "Siddiqui",<br>"company": "",<br>"address\_1": "ABC Road, Garden City",<br>"address\_2": "",<br>"city": "Karachi",<br>"state": "Sindh",<br>"postcode": "",<br>"country": "Pakistan",<br>"email": "<test@gmail.com>",<br>"phone": "+44444"<br>},<br>"shipping": {<br>"first\_name": "test",<br>"last\_name": "test",<br>"company": "",<br>"address\_1": "ABC Road, Garden City",<br>"address\_2": "",<br>"city": "Karachi",<br>"state": "Sindh",<br>"postcode": "",<br>"country": "Pakistan",<br>"phone": ""<br>},<br>"payment\_method": "",<br>"payment\_method\_title": "",<br>"transaction\_id": "",<br>"customer\_ip\_address": "",<br>"customer\_user\_agent": "",<br>"created\_via": "rest-api",<br>"customer\_note": "",<br>"date\_completed": null,<br>"date\_paid": null,<br>"cart\_hash": "",<br>"number": "4597",<br>"meta\_data": \[<br>{<br>"id": 6465,<br>"key": "user\_ns",<br>"value": "f12372u15376836"<br>}<br>],<br>"line\_items": \[<br>{<br>"id": 259,<br>"name": "DNK Black Shoes - blue",<br>"product\_id": 375,<br>"variation\_id": 4120,<br>"quantity": 2,<br>"tax\_class": "",<br>"subtotal": "350.00",<br>"subtotal\_tax": "0.00",<br>"total": "350.00",<br>"total\_tax": "0.00",<br>"taxes": \[...], // 0 items<br>"meta\_data": \[...], // 1 items<br>"sku": "",<br>"price": 175,<br>"image": {...}, // 2 keys<br>"parent\_name": "DNK Black Shoes"<br>}<br>],<br>"tax\_lines": \[<br>],<br>"shipping\_lines": \[<br>],<br>"fee\_lines": \[<br>],<br>"coupon\_lines": \[<br>],<br>"refunds": \[<br>],<br>"payment\_url": "<https://shop.xxxxx.io/checkout-2/order-pay/4597?pay_for_order=true&#x26;key=wc_order_5hKQmDkxUiesi>",<br>"is\_editable": true,<br>"needs\_payment": true,<br>"needs\_processing": true,<br>"date\_created\_gmt": "2023-04-14T11:01:51",<br>"date\_modified\_gmt": "2023-04-14T11:01:51",<br>"date\_completed\_gmt": null,<br>"date\_paid\_gmt": null,<br>"currency\_symbol": "$"<br>}</p> |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Create Order From Single Product <a href="#inlineextension-create-order-from-single-product" id="inlineextension-create-order-from-single-product"></a>

This action is used to create an order of one item or product only. (For multiple items, use create order from cart action).

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FXMlxFJ4RM3BDFE1eceg5%2Fcreate%20order%20single%20product.png?alt=media&#x26;token=e38a5842-98bd-4842-8d6c-e3cbebde10d4" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 4599,<br>"parent\_id": 0,<br>"status": "pending",<br>"currency": "AUD",<br>"version": "6.9.4",<br>"prices\_include\_tax": false,<br>"date\_created": "2023-04-14T18:13:13",<br>"date\_modified": "2023-04-14T18:13:13",<br>"discount\_total": "0.00",<br>"discount\_tax": "0.00",<br>"shipping\_total": "0.00",<br>"shipping\_tax": "0.00",<br>"cart\_tax": "0.00",<br>"total": "175.00",<br>"total\_tax": "0.00",<br>"customer\_id": 4,<br>"order\_key": "wc\_order\_yhGfOfZ0eoCYe",<br>"billing": {<br>"first\_name": "",<br>"last\_name": "",<br>"company": "",<br>"address\_1": "",<br>"address\_2": "",<br>"city": "",<br>"state": "",<br>"postcode": "",<br>"country": "",<br>"email": "<hello@primechat.ai>",<br>"phone": ""<br>},<br>"shipping": {<br>"first\_name": "",<br>"last\_name": "",<br>"company": "",<br>"address\_1": "",<br>"address\_2": "",<br>"city": "",<br>"state": "",<br>"postcode": "",<br>"country": "",<br>"phone": ""<br>},<br>"payment\_method": "",<br>"payment\_method\_title": "",<br>"transaction\_id": "",<br>"customer\_ip\_address": "",<br>"customer\_user\_agent": "",<br>"created\_via": "rest-api",<br>"customer\_note": "",<br>"date\_completed": null,<br>"date\_paid": null,<br>"cart\_hash": "",<br>"number": "4599",<br>"meta\_data": \[<br>],<br>"line\_items": \[<br>{<br>"id": 260,<br>"name": "DNK Black Shoes - blue",<br>"product\_id": 375,<br>"variation\_id": 4120,<br>"quantity": 1,<br>"tax\_class": "",<br>"subtotal": "175.00",<br>"subtotal\_tax": "0.00",<br>"total": "175.00",<br>"total\_tax": "0.00",<br>"taxes": \[...], // 0 items<br>"meta\_data": \[...], // 1 items<br>"sku": "",<br>"price": 175,<br>"image": {...}, // 2 keys<br>"parent\_name": "DNK Black Shoes"<br>}<br>],<br>"tax\_lines": \[<br>],<br>"shipping\_lines": \[<br>],<br>"fee\_lines": \[<br>],<br>"coupon\_lines": \[<br>],<br>"refunds": \[<br>],<br>"payment\_url": "<https://shop.businessa/checkout-2/order-pay/4599?pay_for_order=true&#x26;key=wc_order_yhGfOfZ0eoCYe>",<br>"is\_editable": true,<br>"needs\_payment": true,<br>"needs\_processing": true,<br>"date\_created\_gmt": "2023-04-14T18:13:13",<br>"date\_modified\_gmt": "2023-04-14T18:13:13",<br>"date\_completed\_gmt": null,<br>"date\_paid\_gmt": null,<br>"currency\_symbol": "$"<br>}</p> |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Update Order <a href="#inlineextension-update-order" id="inlineextension-update-order"></a>

This action is used to update the order information and status using order ID

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FsU1BmV1DdtV0hxdbzXLT%2FWoocomerce%20chatbot%20integration36.png?alt=media&#x26;token=04657682-c97d-4611-985f-8af9f2cf934c" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 4597,<br>"parent\_id": 0,<br>"status": "completed",<br>"currency": "AUD",<br>"version": "6.9.4",<br>"prices\_include\_tax": false,<br>"date\_created": "2023-04-14T11:01:51",<br>"date\_modified": "2023-04-14T18:16:14",<br>"discount\_total": "0.00",<br>"discount\_tax": "0.00",<br>"shipping\_total": "0.00",<br>"shipping\_tax": "0.00",<br>"cart\_tax": "0.00",<br>"total": "350.00",<br>"total\_tax": "0.00",<br>"customer\_id": 0,<br>"order\_key": "wc\_order\_5hKQmDkxUiesi",<br>"billing": {<br>"first\_name": "Hammad",<br>"last\_name": "Siddiqui",<br>"company": "",<br>"address\_1": "ABC Road, Garden City",<br>"address\_2": "",<br>"city": "Karachi",<br>"state": "Sindh",<br>"postcode": "",<br>"country": "Pakistan",<br>"email": "<test@gmail.com>",<br>"phone": "+4444444"<br>},<br>"shipping": {<br>"first\_name": "xxxx",<br>"last\_name": "xxx",<br>"company": "",<br>"address\_1": "ABC Road, Garden City",<br>"address\_2": "",<br>"city": "Karachi",<br>"state": "Sindh",<br>"postcode": "",<br>"country": "Pakistan",<br>"phone": ""<br>},<br>"payment\_method": "",<br>"payment\_method\_title": "",<br>"transaction\_id": "",<br>"customer\_ip\_address": "",<br>"customer\_user\_agent": "",<br>"created\_via": "rest-api",<br>"customer\_note": "",<br>"date\_completed": "2023-04-14T18:16:14",<br>"date\_paid": "2023-04-14T18:16:14",<br>"cart\_hash": "",<br>"number": "4597",<br>"meta\_data": \[<br>{<br>"id": 6465,<br>"key": "user\_ns",<br>"value": "f12372u15376836"<br>},<br>{<br>"id": 6499,<br>"key": "\_new\_order\_email\_sent",<br>"value": "true"<br>}<br>],<br>"line\_items": \[<br>{<br>"id": 259,<br>"name": "DNK Black Shoes - blue",<br>"product\_id": 375,<br>"variation\_id": 4120,<br>"quantity": 2,<br>"tax\_class": "",<br>"subtotal": "350.00",<br>"subtotal\_tax": "0.00",<br>"total": "350.00",<br>"total\_tax": "0.00",<br>"taxes": \[...], // 0 items<br>"meta\_data": \[...], // 1 items<br>"sku": "",<br>"price": 175,<br>"image": {...}, // 2 keys<br>"parent\_name": "DNK Black Shoes"<br>}<br>],<br>"tax\_lines": \[<br>],<br>"shipping\_lines": \[<br>],<br>"fee\_lines": \[<br>],<br>"coupon\_lines": \[<br>],<br>"refunds": \[<br>],<br>"payment\_url": "<https://shop.business.io/checkout-2/order-pay/4597?pay_for_order=true&#x26;key=wc_order_5hKQmDkxUiesi>",<br>"is\_editable": false,<br>"needs\_payment": false,<br>"needs\_processing": true,<br>"date\_created\_gmt": "2023-04-14T11:01:51",<br>"date\_modified\_gmt": "2023-04-14T18:16:14",<br>"date\_completed\_gmt": "2023-04-14T18:16:14",<br>"date\_paid\_gmt": "2023-04-14T18:16:14",<br>"currency\_symbol": "$"<br>}</p> |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Delete Order <a href="#inlineextension-delete-order" id="inlineextension-delete-order"></a>

This action is used to delete an order using the order ID.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FdUlGumAGd4lypUOTDk1X%2FWoocomerce%20chatbot%20integration37.png?alt=media&#x26;token=ea93f53f-587c-4351-8bdc-974213fea708" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 4597,<br>"parent\_id": 0,<br>"status": "completed",<br>"currency": "AUD",<br>"version": "6.9.4",<br>"prices\_include\_tax": false,<br>"date\_created": "2023-04-14T11:01:51",<br>"date\_modified": "2023-04-14T18:16:14",<br>"discount\_total": "0.00",<br>"discount\_tax": "0.00",<br>"shipping\_total": "0.00",<br>"shipping\_tax": "0.00",<br>"cart\_tax": "0.00",<br>"total": "350.00",<br>"total\_tax": "0.00",<br>"customer\_id": 0,<br>"order\_key": "wc\_order\_5hKQmDkxUiesi",<br>"billing": {<br>"first\_name": "xxxx",<br>"last\_name": "xxxxi",<br>"company": "",<br>"address\_1": "ABC Road, Garden City",<br>"address\_2": "",<br>"city": "Karachi",<br>"state": "Sindh",<br>"postcode": "",<br>"country": "Pakistan",<br>"email": "<test@gmail.com>",<br>"phone": "+444444"<br>},<br>"shipping": {<br>"first\_name": "xxxx",<br>"last\_name": "xxxxi",<br>"company": "",<br>"address\_1": "ABC Road, Garden City",<br>"address\_2": "",<br>"city": "Karachi",<br>"state": "Sindh",<br>"postcode": "",<br>"country": "Pakistan",<br>"phone": ""<br>},<br>"payment\_method": "",<br>"payment\_method\_title": "",<br>"transaction\_id": "",<br>"customer\_ip\_address": "",<br>"customer\_user\_agent": "",<br>"created\_via": "rest-api",<br>"customer\_note": "",<br>"date\_completed": "2023-04-14T18:16:14",<br>"date\_paid": "2023-04-14T18:16:14",<br>"cart\_hash": "",<br>"number": "4597",<br>"meta\_data": \[<br>{<br>"id": 6465,<br>"key": "user\_ns",<br>"value": "f12372u15376836"<br>},<br>{<br>"id": 6499,<br>"key": "\_new\_order\_email\_sent",<br>"value": "true"<br>}<br>],<br>"line\_items": \[<br>{<br>"id": 259,<br>"name": "DNK Black Shoes - blue",<br>"product\_id": 375,<br>"variation\_id": 4120,<br>"quantity": 2,<br>"tax\_class": "",<br>"subtotal": "350.00",<br>"subtotal\_tax": "0.00",<br>"total": "350.00",<br>"total\_tax": "0.00",<br>"taxes": \[...], // 0 items<br>"meta\_data": \[...], // 1 items<br>"sku": "",<br>"price": 175,<br>"image": {...}, // 2 keys<br>"parent\_name": "DNK Black Shoes"<br>}<br>],<br>"tax\_lines": \[<br>],<br>"shipping\_lines": \[<br>],<br>"fee\_lines": \[<br>],<br>"coupon\_lines": \[<br>],<br>"refunds": \[<br>],<br>"payment\_url": "<https://shop.businessx.io/checkout-2/order-pay/4597?pay_for_order=true&#x26;key=wc_order_5hKQmDkxUiesi>",<br>"is\_editable": false,<br>"needs\_payment": false,<br>"needs\_processing": true,<br>"date\_created\_gmt": "2023-04-14T11:01:51",<br>"date\_modified\_gmt": "2023-04-14T18:16:14",<br>"date\_completed\_gmt": "2023-04-14T18:16:14",<br>"date\_paid\_gmt": "2023-04-14T18:16:14",<br>"currency\_symbol": "$"<br>}</p> |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

#### Create Order Note <a href="#inlineextension-create-order-note" id="inlineextension-create-order-note"></a>

This action is used to create an order note using the order ID.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FrNnxFDN7w6OtGTRbxYS1%2FWoocomerce%20chatbot%20integration38.png?alt=media&#x26;token=61223011-e4e2-4c42-93d5-4f3f6e9865a4" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 65,<br>"author": "WooCommerce",<br>"date\_created": "2023-04-14T18:21:24",<br>"date\_created\_gmt": "2023-04-14T18:21:24",<br>"note": "This is a test order",<br>"customer\_note": false<br>}</p> |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Search For Products <a href="#inlineextension-search-for-products" id="inlineextension-search-for-products"></a>

This action is used to search for products using various parameters and queries.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FZmiFSYu928hmWzVWhRbj%2FWoocomerce%20chatbot%20integration39.png?alt=media&#x26;token=9ad46d90-67a3-4dc1-9709-991079eac089" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FEpHEty4XrXeq5Oz0rvXI%2FWoocomerce%20chatbot%20integration40.png?alt=media&#x26;token=60700fd6-d62c-4c59-b0a8-208a41240e1f" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>\[<br>{<br>"id": 375,<br>"name": "DNK Black Shoes",<br>"slug": "dnk-black-shoes",<br>"permalink": "<https://shop.xxxxxx.io/product/dnk-black-shoes>",<br>"type": "variable",<br>"status": "publish",<br>"featured": false,<br>"catalog\_visibility": "visible",<br>"description": "",<br>"short\_description": "",<br>"sku": "",<br>"price": "175",<br>"regular\_price": "",<br>"sale\_price": "",<br>"date\_on\_sale\_from": null,<br>"date\_on\_sale\_from\_gmt": null,<br>"date\_on\_sale\_to": null,<br>"date\_on\_sale\_to\_gmt": null,<br>"on\_sale": false,<br>"purchasable": true,<br>"total\_sales": 30,<br>"virtual": false,<br>"downloadable": false,<br>"downloads": \[<br>],<br>"download\_limit": -1,<br>"download\_expiry": -1,<br>"external\_url": "",<br>"button\_text": "",<br>"tax\_status": "taxable",<br>"tax\_class": "",<br>"manage\_stock": false,<br>"stock\_quantity": null,<br>"backorders": "no",<br>"backorders\_allowed": false,<br>"backordered": false,<br>"low\_stock\_amount": null,<br>"sold\_individually": false,<br>"weight": "",<br>"dimensions": {<br>"length": "",<br>"width": "",<br>"height": ""<br>},<br>"shipping\_required": true,<br>"shipping\_taxable": true,<br>"shipping\_class": "",<br>"shipping\_class\_id": 0,<br>"reviews\_allowed": true,<br>"average\_rating": "0.00",<br>"rating\_count": 0,<br>"parent\_id": 0,<br>"purchase\_note": "",<br>"attributes": \[<br>],<br>"variations": \[<br>4120,<br>4119,<br>4122,<br>4121<br>],<br>"grouped\_products": \[<br>],<br>"menu\_order": 0,<br>"related\_ids": \[<br>242,<br>229,<br>86,<br>211,<br>79<br>],<br>"stock\_status": "instock",<br>"has\_options": true,<br>"image": "<https://shop.business.io/wp-content/uploads/2021/03/sports-shoe5.jpg>"<br>}<br>]</p> |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Get Product Info <a href="#inlineextension-get-product-info" id="inlineextension-get-product-info"></a>

This action is used to fetch product information using the product ID.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FoMeBYXqwxI6HVEu5VVeX%2Fget%20proiduct%20info.png?alt=media&#x26;token=a73dda9d-e5ae-43c0-a0f2-fbd96cdd6b3c" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 375,<br>"name": "DNK Black Shoes",<br>"slug": "dnk-black-shoes",<br>"permalink": "<https://shop.xxxxx.io/product/dnk-black-shoes>",<br>"type": "variable",<br>"status": "publish",<br>"featured": false,<br>"catalog\_visibility": "visible",<br>"description": "",<br>"short\_description": "",<br>"sku": "",<br>"price": "175",<br>"regular\_price": "",<br>"sale\_price": "",<br>"date\_on\_sale\_from": null,<br>"date\_on\_sale\_from\_gmt": null,<br>"date\_on\_sale\_to": null,<br>"date\_on\_sale\_to\_gmt": null,<br>"on\_sale": false,<br>"purchasable": true,<br>"total\_sales": 30,<br>"virtual": false,<br>"downloadable": false,<br>"downloads": \[<br>],<br>"download\_limit": -1,<br>"download\_expiry": -1,<br>"external\_url": "",<br>"button\_text": "",<br>"tax\_status": "taxable",<br>"tax\_class": "",<br>"manage\_stock": false,<br>"stock\_quantity": null,<br>"backorders": "no",<br>"backorders\_allowed": false,<br>"backordered": false,<br>"low\_stock\_amount": null,<br>"sold\_individually": false,<br>"weight": "",<br>"dimensions": {<br>"length": "",<br>"width": "",<br>"height": ""<br>},<br>"shipping\_required": true,<br>"shipping\_taxable": true,<br>"shipping\_class": "",<br>"shipping\_class\_id": 0,<br>"reviews\_allowed": true,<br>"average\_rating": "0.00",<br>"rating\_count": 0,<br>"parent\_id": 0,<br>"purchase\_note": "",<br>"attributes": \[<br>],<br>"variations": \[<br>4120,<br>4119,<br>4122,<br>4121<br>],<br>"grouped\_products": \[<br>],<br>"menu\_order": 0,<br>"related\_ids": \[<br>247,<br>209,<br>160,<br>169,<br>109<br>],<br>"stock\_status": "instock",<br>"has\_options": true,<br>"image": "<https://shop.business.io/wp-content/uploads/2021/03/sports-shoe5.jpg>"<br>}</p> |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Create Product <a href="#inlineextension-create-product" id="inlineextension-create-product"></a>

This action is used to create a product on your Woocommerce store.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FkxxXzztmkQLs18Zykc0F%2FWoocomerce%20chatbot%20integration41.png?alt=media&#x26;token=eb7b177b-0d06-4473-9513-3def4318f37a" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2F74iJnbScCmD33ooJ58fV%2FWoocomerce%20chatbot%20integration42.png?alt=media&#x26;token=76a86465-bed2-47f5-8490-94117af6ef20" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 4600,<br>"name": "Test Product",<br>"slug": "test-product",<br>"permalink": "<https://shop.xxxxx.io/product/test-product>",<br>"type": "simple",<br>"status": "publish",<br>"featured": false,<br>"catalog\_visibility": "visible",<br>"description": "this is a test product",<br>"short\_description": "",<br>"sku": "123456",<br>"price": "10",<br>"regular\_price": "10",<br>"sale\_price": "",<br>"date\_on\_sale\_from": null,<br>"date\_on\_sale\_from\_gmt": null,<br>"date\_on\_sale\_to": null,<br>"date\_on\_sale\_to\_gmt": null,<br>"on\_sale": false,<br>"purchasable": true,<br>"total\_sales": 0,<br>"virtual": false,<br>"downloadable": false,<br>"downloads": \[<br>],<br>"download\_limit": -1,<br>"download\_expiry": -1,<br>"external\_url": "",<br>"button\_text": "",<br>"tax\_status": "taxable",<br>"tax\_class": "",<br>"manage\_stock": false,<br>"stock\_quantity": null,<br>"backorders": "no",<br>"backorders\_allowed": false,<br>"backordered": false,<br>"low\_stock\_amount": null,<br>"sold\_individually": false,<br>"weight": "",<br>"dimensions": {<br>"length": "",<br>"width": "",<br>"height": ""<br>},<br>"shipping\_required": true,<br>"shipping\_taxable": true,<br>"shipping\_class": "",<br>"shipping\_class\_id": 0,<br>"reviews\_allowed": true,<br>"average\_rating": "0",<br>"rating\_count": 0,<br>"parent\_id": 0,<br>"purchase\_note": "",<br>"attributes": \[<br>],<br>"variations": \[<br>],<br>"grouped\_products": \[<br>],<br>"menu\_order": 0,<br>"related\_ids": \[<br>109,<br>212,<br>157,<br>210,<br>229<br>],<br>"stock\_status": "instock",<br>"has\_options": false,<br>"image": null<br>}</p> |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Update Product <a href="#inlineextension-update-product" id="inlineextension-update-product"></a>

This action is used to update the product details using the product ID

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FhlBOoRjLojGfaWdGeUVf%2FWoocomerce%20chatbot%20integration43.png?alt=media&#x26;token=9a3a8c02-2c8c-48c4-9571-e8389538687c" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 4600,<br>"name": "Test Product",<br>"slug": "test-product",<br>"permalink": "<https://shop.business.io/?post_type=product&#x26;p=4600>",<br>"type": "simple",<br>"status": "pending",<br>"featured": false,<br>"catalog\_visibility": "visible",<br>"description": "this is a test product",<br>"short\_description": "",<br>"sku": "123456",<br>"price": "10",<br>"regular\_price": "10",<br>"sale\_price": "",<br>"date\_on\_sale\_from": null,<br>"date\_on\_sale\_from\_gmt": null,<br>"date\_on\_sale\_to": null,<br>"date\_on\_sale\_to\_gmt": null,<br>"on\_sale": false,<br>"purchasable": true,<br>"total\_sales": 0,<br>"virtual": false,<br>"downloadable": false,<br>"downloads": \[<br>],<br>"download\_limit": -1,<br>"download\_expiry": -1,<br>"external\_url": "",<br>"button\_text": "",<br>"tax\_status": "taxable",<br>"tax\_class": "",<br>"manage\_stock": false,<br>"stock\_quantity": null,<br>"backorders": "no",<br>"backorders\_allowed": false,<br>"backordered": false,<br>"low\_stock\_amount": null,<br>"sold\_individually": false,<br>"weight": "",<br>"dimensions": {<br>"length": "",<br>"width": "",<br>"height": ""<br>},<br>"shipping\_required": true,<br>"shipping\_taxable": true,<br>"shipping\_class": "",<br>"shipping\_class\_id": 0,<br>"reviews\_allowed": true,<br>"average\_rating": "0",<br>"rating\_count": 0,<br>"parent\_id": 0,<br>"purchase\_note": "",<br>"attributes": \[<br>],<br>"variations": \[<br>],<br>"grouped\_products": \[<br>],<br>"menu\_order": 0,<br>"related\_ids": \[<br>252,<br>86,<br>247,<br>95,<br>242<br>],<br>"stock\_status": "instock",<br>"has\_options": false,<br>"image": null<br>}</p> |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

#### Delete Product <a href="#inlineextension-delete-product" id="inlineextension-delete-product"></a>

This action is used to delete a product using the product ID.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2Fz12uAQv0Q8pxJvAo3Flh%2FWoocomerce%20chatbot%20integration44.png?alt=media&#x26;token=12c8e76a-a9c8-4d67-8093-7f6e3ab7be80" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 4600,<br>"name": "Test Product",<br>"slug": "test-product",<br>"permalink": "<https://shop.xxxxxxx.io/?post_type=product&#x26;p=4600>",<br>"date\_created": "2023-04-15T01:02:07",<br>"date\_created\_gmt": "2023-04-15T01:02:07",<br>"date\_modified": "2023-04-15T01:03:28",<br>"date\_modified\_gmt": "2023-04-15T01:03:28",<br>"type": "simple",<br>"status": "pending",<br>"featured": false,<br>"catalog\_visibility": "visible",<br>"description": "this is a test product",<br>"short\_description": "",<br>"sku": "123456",<br>"price": "10",<br>"regular\_price": "10",<br>"sale\_price": "",<br>"date\_on\_sale\_from": null,<br>"date\_on\_sale\_from\_gmt": null,<br>"date\_on\_sale\_to": null,<br>"date\_on\_sale\_to\_gmt": null,<br>"on\_sale": false,<br>"purchasable": true,<br>"total\_sales": 0,<br>"virtual": false,<br>"downloadable": false,<br>"downloads": \[<br>],<br>"download\_limit": -1,<br>"download\_expiry": -1,<br>"external\_url": "",<br>"button\_text": "",<br>"tax\_status": "taxable",<br>"tax\_class": "",<br>"manage\_stock": false,<br>"stock\_quantity": null,<br>"backorders": "no",<br>"backorders\_allowed": false,<br>"backordered": false,<br>"low\_stock\_amount": null,<br>"sold\_individually": false,<br>"weight": "",<br>"dimensions": {<br>"length": "",<br>"width": "",<br>"height": ""<br>},<br>"shipping\_required": true,<br>"shipping\_taxable": true,<br>"shipping\_class": "",<br>"shipping\_class\_id": 0,<br>"reviews\_allowed": true,<br>"average\_rating": "0",<br>"rating\_count": 0,<br>"upsell\_ids": \[<br>],<br>"cross\_sell\_ids": \[<br>],<br>"parent\_id": 0,<br>"purchase\_note": "",<br>"categories": \[<br>{<br>"id": 49,<br>"name": "Women",<br>"slug": "women"<br>}<br>],<br>"tags": \[<br>{<br>"id": 57,<br>"name": "Test Product",<br>"slug": "test-product"<br>}<br>],<br>"images": \[<br>],<br>"attributes": \[<br>],<br>"default\_attributes": \[<br>],<br>"variations": \[<br>],<br>"grouped\_products": \[<br>],<br>"menu\_order": 0,<br>"price\_html": "\<span class="woocommerce-Price-amount amount">\<bdi>\<span class="woocommerce-Price-currencySymbol">\&#36;\</span>10.00\</bdi>\</span>",<br>"related\_ids": \[<br>160,<br>157,<br>194,<br>210,<br>252<br>],<br>"meta\_data": \[<br>],<br>"stock\_status": "instock",<br>"has\_options": false<br>}</p> |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Search For Product Variants <a href="#inlineextension-search-for-product-variants" id="inlineextension-search-for-product-variants"></a>

This action is used for searching product variants based on various filters.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FM7cogBpwJJX6rRwyhqDn%2Fsearch%20product%20variant%201.png?alt=media&#x26;token=21a7dbac-c444-4a59-a7f6-cb43d1e8e2e5" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FKbXYYypwumD1HfVdU6Rh%2Fsearch%20product%20variant%202.png?alt=media&#x26;token=10fb44c1-59f3-458f-a7c1-9aeead8abb35" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>\[<br>{<br>"id": 4122,<br>"date\_created": "2022-08-17T08:01:49",<br>"date\_created\_gmt": "2022-08-17T08:01:49",<br>"date\_modified": "2022-08-17T08:01:49",<br>"date\_modified\_gmt": "2022-08-17T08:01:49",<br>"description": "",<br>"permalink": "<https://shop.business.io/product/dnk-black-shoes?attribute_pa_color=red>",<br>"sku": "",<br>"price": "195",<br>"regular\_price": "195",<br>"sale\_price": "",<br>"date\_on\_sale\_from": null,<br>"date\_on\_sale\_from\_gmt": null,<br>"date\_on\_sale\_to": null,<br>"date\_on\_sale\_to\_gmt": null,<br>"on\_sale": false,<br>"status": "publish",<br>"purchasable": true,<br>"virtual": false,<br>"downloadable": false,<br>"downloads": \[<br>],<br>"download\_limit": -1,<br>"download\_expiry": -1,<br>"tax\_status": "taxable",<br>"tax\_class": "",<br>"manage\_stock": false,<br>"stock\_quantity": null,<br>"stock\_status": "instock",<br>"backorders": "no",<br>"backorders\_allowed": false,<br>"backordered": false,<br>"low\_stock\_amount": null,<br>"weight": "",<br>"dimensions": {<br>"length": "",<br>"width": "",<br>"height": ""<br>},<br>"shipping\_class": "",<br>"shipping\_class\_id": 0,<br>"image": {<br>"id": 2462,<br>"date\_created": "2021-03-05T07:22:32",<br>"date\_created\_gmt": "2021-03-05T07:22:32",<br>"date\_modified": "2021-03-05T07:22:32",<br>"date\_modified\_gmt": "2021-03-05T07:22:32",<br>"src": "<https://shop.business.io/wp-content/uploads/2021/03/sports-shoe2.jpg>",<br>"name": "sports-shoe2",<br>"alt": ""<br>},<br>"attributes": \[<br>{...} // 3 keys<br>],<br>"menu\_order": 3,<br>"meta\_data": \[<br>{...}, // 3 keys<br>{...}, // 3 keys<br>{...} // 3 keys<br>],<br>"\_links": {<br>"self": \[...], // 1 items<br>"collection": \[...], // 1 items<br>"up": \[...] // 1 items<br>}<br>}<br>]</p> |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Get Product Variant Info <a href="#inlineextension-get-product-variant-info" id="inlineextension-get-product-variant-info"></a>

This action is used to fetch information for a variant using its variant ID and product ID

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2Fgc5ldlgiQSXN1S8xgVgN%2FWoocomerce%20chatbot%20integration45.png?alt=media&#x26;token=b6fedef1-8fb8-473e-9894-78daee19bc5e" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 4122,<br>"date\_created": "2022-08-17T08:01:49",<br>"date\_created\_gmt": "2022-08-17T08:01:49",<br>"date\_modified": "2022-08-17T08:01:49",<br>"date\_modified\_gmt": "2022-08-17T08:01:49",<br>"description": "",<br>"permalink": "<https://shop.xxxxx.io/product/dnk-black-shoes?attribute_pa_color=red>",<br>"sku": "",<br>"price": "195",<br>"regular\_price": "195",<br>"sale\_price": "",<br>"date\_on\_sale\_from": null,<br>"date\_on\_sale\_from\_gmt": null,<br>"date\_on\_sale\_to": null,<br>"date\_on\_sale\_to\_gmt": null,<br>"on\_sale": false,<br>"status": "publish",<br>"purchasable": true,<br>"virtual": false,<br>"downloadable": false,<br>"downloads": \[<br>],<br>"download\_limit": -1,<br>"download\_expiry": -1,<br>"tax\_status": "taxable",<br>"tax\_class": "",<br>"manage\_stock": false,<br>"stock\_quantity": null,<br>"stock\_status": "instock",<br>"backorders": "no",<br>"backorders\_allowed": false,<br>"backordered": false,<br>"low\_stock\_amount": null,<br>"weight": "",<br>"dimensions": {<br>"length": "",<br>"width": "",<br>"height": ""<br>},<br>"shipping\_class": "",<br>"shipping\_class\_id": 0,<br>"image": {<br>"id": 2462,<br>"date\_created": "2021-03-05T07:22:32",<br>"date\_created\_gmt": "2021-03-05T07:22:32",<br>"date\_modified": "2021-03-05T07:22:32",<br>"date\_modified\_gmt": "2021-03-05T07:22:32",<br>"src": "<https://shop.business.io/wp-content/uploads/2021/03/sports-shoe2.jpg>",<br>"name": "sports-shoe2",<br>"alt": ""<br>},<br>"attributes": \[<br>{<br>"id": 0,<br>"name": "color",<br>"option": "red"<br>}<br>],<br>"menu\_order": 3,<br>"meta\_data": \[<br>{<br>"id": 3030,<br>"key": "\_wxr\_import\_user\_slug",<br>"value": "alex"<br>},<br>{<br>"id": 3031,<br>"key": "\_astra\_sites\_imported\_post",<br>"value": "1"<br>},<br>{<br>"id": 3032,<br>"key": "\_astra\_sites\_enable\_for\_batch",<br>"value": "1"<br>}<br>]<br>}</p> |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Search For Categories <a href="#inlineextension-search-for-categories" id="inlineextension-search-for-categories"></a>

This action is used to fetch categories using various parameters and queries.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FuJbA1AOWHuvCUBKxLx9q%2FWoocomerce%20chatbot%20integration46.png?alt=media&#x26;token=4334099a-5795-4ba2-b72b-b4c3f8e90999" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>\[<br>{<br>"id": 49,<br>"name": "Women",<br>"slug": "women",<br>"parent": 0,<br>"description": " Nam nec tellus a odio tincidunt auctor a ornare odio. Sed non mauris vitae erat consequat auctor eu in elit. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Mauris in erat justo. Nullam ac urna eu felis dapibus condimentum sit amet a augue. Sed non neque elit sed ut. ",<br>"display": "default",<br>"image": {<br>"id": 500,<br>"date\_created": "2018-12-06T05:50:12",<br>"date\_created\_gmt": "2018-12-06T05:50:12",<br>"date\_modified": "2022-10-06T23:57:20",<br>"date\_modified\_gmt": "2022-10-06T23:57:20",<br>"src": "<https://shop.business.io/wp-content/uploads/2018/12/women-fashion-free-img.jpg>",<br>"name": "women-fashion-free-img",<br>"alt": ""<br>},<br>"menu\_order": 0,<br>"count": 17,<br>"\_links": {<br>"self": \[...], // 1 items<br>"collection": \[...] // 1 items<br>}<br>}<br>]</p> |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Get Category Info <a href="#inlineextension-get-category-info" id="inlineextension-get-category-info"></a>

This action is used to fetch information for a category using its category ID.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FgAL165FJ7W9VSqqoQzFk%2FWoocomerce%20chatbot%20integration47.png?alt=media&#x26;token=a6721ac5-ace4-4ef8-8dcc-4264ea7ddf0f" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>\[<br>{<br>"id": 49,<br>"name": "Women",<br>"slug": "women",<br>"parent": 0,<br>"description": " Nam nec tellus a odio tincidunt auctor a ornare odio. Sed non mauris vitae erat consequat auctor eu in elit. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Mauris in erat justo. Nullam ac urna eu felis dapibus condimentum sit amet a augue. Sed non neque elit sed ut. ",<br>"display": "default",<br>"image": {<br>"id": 500,<br>"date\_created": "2018-12-06T05:50:12",<br>"date\_created\_gmt": "2018-12-06T05:50:12",<br>"date\_modified": "2022-10-06T23:57:20",<br>"date\_modified\_gmt": "2022-10-06T23:57:20",<br>"src": "<https://shop.xxxxxx.io/wp-content/uploads/2018/12/women-fashion-free-img.jpg>",<br>"name": "women-fashion-free-img",<br>"alt": ""<br>},<br>"menu\_order": 0,<br>"count": 17,<br>"\_links": {<br>"self": \[...], // 1 items<br>"collection": \[...] // 1 items<br>}<br>}<br>]</p> |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

#### Get Product Tag Info <a href="#inlineextension-get-product-tag-info" id="inlineextension-get-product-tag-info"></a>

This action is used to fetch information for product tags using tag ID.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2Fw06fAnzGQoVCzpRJFjo8%2FWoocomerce%20chatbot%20integration48.png?alt=media&#x26;token=59d49b29-9e9b-4019-833e-7cb553b1b715" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>\[<br>{<br>"id": 49,<br>"name": "Women",<br>"slug": "women",<br>"parent": 0,<br>"description": " Nam nec tellus a odio tincidunt auctor a ornare odio. Sed non mauris vitae erat consequat auctor eu in elit. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Mauris in erat justo. Nullam ac urna eu felis dapibus condimentum sit amet a augue. Sed non neque elit sed ut. ",<br>"display": "default",<br>"image": {<br>"id": 500,<br>"date\_created": "2018-12-06T05:50:12",<br>"date\_created\_gmt": "2018-12-06T05:50:12",<br>"date\_modified": "2022-10-06T23:57:20",<br>"date\_modified\_gmt": "2022-10-06T23:57:20",<br>"src": "<https://shop.xxxx.io/wp-content/uploads/2018/12/women-fashion-free-img.jpg>",<br>"name": "women-fashion-free-img",<br>"alt": ""<br>},<br>"menu\_order": 0,<br>"count": 17,<br>"\_links": {<br>"self": \[...], // 1 items<br>"collection": \[...] // 1 items<br>}<br>}<br>]</p> |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Create Product Tag <a href="#inlineextension-create-product-tag" id="inlineextension-create-product-tag"></a>

This action is used to create a product tag.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FrdqYCp9IMqfnkNBqYVp4%2FWoocomerce%20chatbot%20integration49.png?alt=media&#x26;token=b5247fa7-f9ea-4f96-be8f-11ab83120414" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 57,<br>"name": "Test Product",<br>"slug": "test-product",<br>"description": "this is a test product",<br>"count": 0<br>}</p> |
| ------------------------------------------------------------------------------------------------------------------------------------------ |

#### List All Shipping Methods <a href="#inlineextension-list-all-shipping-methods" id="inlineextension-list-all-shipping-methods"></a>

This action is used to list all the shipping methods available for the store.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FSdHb79m2362O6y6vDX6t%2FWoocomerce%20chatbot%20integration50.png?alt=media&#x26;token=e3f54e50-1661-45c3-aaaf-dafdef56c7eb" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>\[<br>{<br>"id": "flat\_rate",<br>"title": "Flat rate",<br>"description": "Lets you charge a fixed rate for shipping.",<br>"\_links": {<br>"self": \[...], // 1 items<br>"collection": \[...] // 1 items<br>}<br>},<br>{<br>"id": "free\_shipping",<br>"title": "Free shipping",<br>"description": "Free shipping is a special method which can be triggered with coupons and minimum spends.",<br>"\_links": {<br>"self": \[...], // 1 items<br>"collection": \[...] // 1 items<br>}<br>},<br>{<br>"id": "local\_pickup",<br>"title": "Local pickup",<br>"description": "Allow customers to pick up orders themselves. By default, when using local pickup store base taxes will apply regardless of customer address.",<br>"\_links": {<br>"self": \[...], // 1 items<br>"collection": \[...] // 1 items<br>}<br>}<br>]</p> |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Create A Product Review <a href="#inlineextension-create-a-product-review" id="inlineextension-create-a-product-review"></a>

This action is used to create a review for a product.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2Fi6GzjCFLKa760fYVISvY%2FWoocomerce%20chatbot%20integration51.png?alt=media&#x26;token=819bcb2b-9318-41a4-8c79-ab86235190df" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 66,<br>"date\_created": "2023-04-15T02:02:44",<br>"date\_created\_gmt": "2023-04-15T02:02:44",<br>"product\_id": 375,<br>"product\_name": "DNK Black Shoes",<br>"product\_permalink": "<https://shop.xxxxx.io/product/dnk-black-shoes>",<br>"status": "approved",<br>"reviewer": "John Jigga",<br>"reviewer\_email": "<jigga69@gmail.com>",<br>"review": "This is a very good product, me likes",<br>"rating": 4,<br>"verified": false,<br>"reviewer\_avatar\_urls": {<br>"24": "<https://secure.gravatar.com/avatar/fbe4f4181cb19f28ab07c9b4967048ab?s=24&#x26;d=mm&#x26;r=g>",<br>"48": "<https://secure.gravatar.com/avatar/fbe4f4181cb19f28ab07c9b4967048ab?s=48&#x26;d=mm&#x26;r=g>",<br>"96": "<https://secure.gravatar.com/avatar/fbe4f4181cb19f28ab07c9b4967048ab?s=96&#x26;d=mm&#x26;r=g>"<br>}<br>}</p> |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Search Product Reviews <a href="#inlineextension-search-product-reviews" id="inlineextension-search-product-reviews"></a>

This action is used to fetch product reviews using various filters and parameters.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FH17bwGOYSDnI3r1A9E4j%2FWoocomerce%20chatbot%20integration52.png?alt=media&#x26;token=42240e73-0e8e-4697-8021-d8d39c31f8a4" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>\[<br>{<br>"id": 66,<br>"date\_created": "2023-04-15T02:02:44",<br>"date\_created\_gmt": "2023-04-15T02:02:44",<br>"product\_id": 375,<br>"product\_name": "DNK Black Shoes",<br>"product\_permalink": "<https://shop.xxxxx.io/product/dnk-black-shoes>",<br>"status": "approved",<br>"reviewer": "John Jigga",<br>"reviewer\_email": "<jigga69@gmail.com>",<br>"review": "\<p>This is a very good product, me likes\</p> ",<br>"rating": 4,<br>"verified": false,<br>"reviewer\_avatar\_urls": {<br>"24": "<https://secure.gravatar.com/avatar/fbe4f4181cb19f28ab07c9b4967048ab?s=24&d=mm&r=g>",<br>"48": "<https://secure.gravatar.com/avatar/fbe4f4181cb19f28ab07c9b4967048ab?s=48&d=mm&r=g>",<br>"96": "<https://secure.gravatar.com/avatar/fbe4f4181cb19f28ab07c9b4967048ab?s=96&d=mm&r=g>"<br>},<br>"\_links": {<br>"self": \[...], // 1 items<br>"collection": \[...], // 1 items<br>"up": \[...] // 1 items<br>}<br>}<br>]</p> |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### WooCommerce Native Triggers <a href="#inlineextension-woocommerce-native-triggers" id="inlineextension-woocommerce-native-triggers"></a>

Woocommerce integrates natively with Primechat to provide webhook triggers. These triggers are triggered whenever an event is carried out on the Woocommerce store either via an api or directly from the store.

WooCommerce support following native triggers

#### Order Creation <a href="#inlineextension-order-creation" id="inlineextension-order-creation"></a>

This trigger is fired whenever an order is created on Woocommerce store, either via an API or directly from the store.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FLYF9TUCcLLyP6kMzS2h0%2FWoocomerce%20chatbot%20integration53.png?alt=media&#x26;token=984b0d2e-9525-4acb-866f-aa8ac12d4687" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 4599,<br>"parent\_id": 0,<br>"status": "pending",<br>"currency": "AUD",<br>"version": "6.9.4",<br>"prices\_include\_tax": false,<br>"date\_created": "2023-04-14T18:13:13",<br>"date\_modified": "2023-04-14T18:13:13",<br>"discount\_total": "0.00",<br>"discount\_tax": "0.00",<br>"shipping\_total": "0.00",<br>"shipping\_tax": "0.00",<br>"cart\_tax": "0.00",<br>"total": "175.00",<br>"total\_tax": "0.00",<br>"customer\_id": 4,<br>"order\_key": "wc\_order\_yhGfOfZ0eoCYe",<br>"billing": {<br>"first\_name": "",<br>"last\_name": "",<br>"company": "",<br>"address\_1": "",<br>"address\_2": "",<br>"city": "",<br>"state": "",<br>"postcode": "",<br>"country": "",<br>"email": "<hello@primechat.ai>",<br>"phone": ""<br>},<br>"shipping": {<br>"first\_name": "",<br>"last\_name": "",<br>"company": "",<br>"address\_1": "",<br>"address\_2": "",<br>"city": "",<br>"state": "",<br>"postcode": "",<br>"country": "",<br>"phone": ""<br>},<br>"payment\_method": "",<br>"payment\_method\_title": "",<br>"transaction\_id": "",<br>"customer\_ip\_address": "",<br>"customer\_user\_agent": "",<br>"created\_via": "rest-api",<br>"customer\_note": "",<br>"date\_completed": null,<br>"date\_paid": null,<br>"cart\_hash": "",<br>"number": "4599",<br>"meta\_data": \[<br>],<br>"line\_items": \[<br>{<br>"id": 260,<br>"name": "DNK Black Shoes - blue",<br>"product\_id": 375,<br>"variation\_id": 4120,<br>"quantity": 1,<br>"tax\_class": "",<br>"subtotal": "175.00",<br>"subtotal\_tax": "0.00",<br>"total": "175.00",<br>"total\_tax": "0.00",<br>"taxes": \[...], // 0 items<br>"meta\_data": \[...], // 1 items<br>"sku": "",<br>"price": 175,<br>"image": {...}, // 2 keys<br>"parent\_name": "DNK Black Shoes"<br>}<br>],<br>"tax\_lines": \[<br>],<br>"shipping\_lines": \[<br>],<br>"fee\_lines": \[<br>],<br>"coupon\_lines": \[<br>],<br>"refunds": \[<br>],<br>"payment\_url": "<https://shop.xxxxx.io/checkout-2/order-pay/4599?pay_for_order=true&#x26;key=wc_order_yhGfOfZ0eoCYe>",<br>"is\_editable": true,<br>"needs\_payment": true,<br>"needs\_processing": true,<br>"date\_created\_gmt": "2023-04-14T18:13:13",<br>"date\_modified\_gmt": "2023-04-14T18:13:13",<br>"date\_completed\_gmt": null,<br>"date\_paid\_gmt": null,<br>"currency\_symbol": "$"<br>}</p> |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### Order Update <a href="#inlineextension-order-update" id="inlineextension-order-update"></a>

This trigger is fired whenever an order is updated in Woocommerce store either via an API or directly from the store itself.

<figure><img src="https://1845383182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0a8LLhirT2ZqXdY3anD6%2Fuploads%2FCIEJzf4dgfaEIXBM7h7D%2FWoocomerce%20chatbot%20integration54.png?alt=media&#x26;token=a38fe62d-276a-4d8c-a0b9-79b7d6b9880d" alt=""><figcaption></figcaption></figure>

Following response payload is received.

| <p>{<br>"id": 4597,<br>"parent\_id": 0,<br>"status": "completed",<br>"currency": "AUD",<br>"version": "6.9.4",<br>"prices\_include\_tax": false,<br>"date\_created": "2023-04-14T11:01:51",<br>"date\_modified": "2023-04-14T18:16:14",<br>"discount\_total": "0.00",<br>"discount\_tax": "0.00",<br>"shipping\_total": "0.00",<br>"shipping\_tax": "0.00",<br>"cart\_tax": "0.00",<br>"total": "350.00",<br>"total\_tax": "0.00",<br>"customer\_id": 0,<br>"order\_key": "wc\_order\_5hKQmDkxUiesi",<br>"billing": {<br>"first\_name": "Hammad",<br>"last\_name": "Siddiqui",<br>"company": "",<br>"address\_1": "ABC Road, Garden City",<br>"address\_2": "",<br>"city": "Karachi",<br>"state": "Sindh",<br>"postcode": "",<br>"country": "Pakistan",<br>"email": "<test@gmail.com>",<br>"phone": "+9230302320964"<br>},<br>"shipping": {<br>"first\_name": "Hammad",<br>"last\_name": "Siddiqui",<br>"company": "",<br>"address\_1": "ABC Road, Garden City",<br>"address\_2": "",<br>"city": "Karachi",<br>"state": "Sindh",<br>"postcode": "",<br>"country": "Pakistan",<br>"phone": ""<br>},<br>"payment\_method": "",<br>"payment\_method\_title": "",<br>"transaction\_id": "",<br>"customer\_ip\_address": "",<br>"customer\_user\_agent": "",<br>"created\_via": "rest-api",<br>"customer\_note": "",<br>"date\_completed": "2023-04-14T18:16:14",<br>"date\_paid": "2023-04-14T18:16:14",<br>"cart\_hash": "",<br>"number": "4597",<br>"meta\_data": \[<br>{<br>"id": 6465,<br>"key": "user\_ns",<br>"value": "f12372u15376836"<br>},<br>{<br>"id": 6499,<br>"key": "\_new\_order\_email\_sent",<br>"value": "true"<br>}<br>],<br>"line\_items": \[<br>{<br>"id": 259,<br>"name": "DNK Black Shoes - blue",<br>"product\_id": 375,<br>"variation\_id": 4120,<br>"quantity": 2,<br>"tax\_class": "",<br>"subtotal": "350.00",<br>"subtotal\_tax": "0.00",<br>"total": "350.00",<br>"total\_tax": "0.00",<br>"taxes": \[...], // 0 items<br>"meta\_data": \[...], // 1 items<br>"sku": "",<br>"price": 175,<br>"image": {...}, // 2 keys<br>"parent\_name": "DNK Black Shoes"<br>}<br>],<br>"tax\_lines": \[<br>],<br>"shipping\_lines": \[<br>],<br>"fee\_lines": \[<br>],<br>"coupon\_lines": \[<br>],<br>"refunds": \[<br>],<br>"payment\_url": "<https://shop.xxxxxx.io/checkout-2/order-pay/4597?pay_for_order=true&#x26;key=wc_order_5hKQmDkxUiesi>",<br>"is\_editable": false,<br>"needs\_payment": false,<br>"needs\_processing": true,<br>"date\_created\_gmt": "2023-04-14T11:01:51",<br>"date\_modified\_gmt": "2023-04-14T18:16:14",<br>"date\_completed\_gmt": "2023-04-14T18:16:14",<br>"date\_paid\_gmt": "2023-04-14T18:16:14",<br>"currency\_symbol": "$"<br>}</p> |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#### User Creation Using Triggers <a href="#inlineextension-user-creation-using-triggers" id="inlineextension-user-creation-using-triggers"></a>

Primechat identifies the information coming from the trigger payload and matches it with the existing bot users. If found, the flow is executed for that user. If the user is not found then a user is created using the information that comes with in payload.

If email and phone are both available then a user is created under Web channel, if only email is available then user is still created under Web channel. If phone only is available then the user is created as Whatsapp channel.

If the above required minimum information does not come with the payload, then the trigger is unable to either identify or create a user and hence the trigger is not fired.
