Articles in this section

Available WooCommerce APIs

When you configure an export, import, or other type of flow step using the prebuilt WooCommerce connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the WooCommerce API documentation. You can also create a composite endpoint for this application in HTTP mode.

API v2 version operations

Resource API endpoint Export Import
Coupons (v2) List all coupons X
Retrieve a coupon X
Create a coupon X
Update a coupon X
Delete a coupon X
Batch update coupons X
Customers (v2) List all customers X
Retrieve a customer X
Retrieve customer downloads X
Create a customer X
Update a customer X
Delete a customer X
Batch update customers X
Order notes (v2) List all order notes X
Retrieve an order note X
Create an order note X
Delete an order note X
Orders (v2) List all orders X
Retrieve an order X
Create an order X
Update an order X
Delete an order X
Batch update orders X
Payment gateways (v2) List all payment gateways X
Retrieve a payment gateway X
Update a payment gateway X
Product attribute terms (v2) List all attribute terms X
Retrieve an attribute term X
Create an attribute term X
Update an attribute term X
Delete an attribute term X
Product attributes (v2) List all product attributes X
Retrieve a product attribute X
Create a product attribute X
Update a product attribute X
Delete a product attribute X
Batch update product attributes X
Product categories (v2) List all product categories X
Retrieve a product category X
Create a product category X
Update a product category X
Delete a product category X
Batch update product categories X
Product shipping classes (v2) List all shipping classes X
Retrieve a shipping class X
Create a shipping class X
Update a shipping class X
Delete a shipping class X
Batch update shipping classes X
Product tags (v2) List all product tags X
Retrieve a product tag X
Create a product tag X
Update a product tag X
Delete a product tag X
Batch update product tags X
Product variations (v2) List all product variations X
Retrieve a product variation X
Create a product variation X
Update a product variation X
Delete a product variation X
Batch update product variations X
Products (v2) List all products X
Retrieve a product X
List all product reviews X
Retrieve product reviews X
Create a product X
Update a product X
Delete a product X
Batch update product X
Refunds (v2) List all refunds X
Retrieve a refund X
Create a refund X
Delete a refund X
Reports (v2) List all reports X
Retrieve sales report X
Retrieve top sellers report X
Setting options (v2) List all setting options X
Retrieve a setting option X
Update a setting option X
Batch update setting options X
Settings (v2) List all settings groups X
Shipping zone locations (v2) List all locations of a shipping zone X
List all shipping methods from a shipping zone X
Retrieve a shipping method from a shipping zone X
List all shipping methods X
Retrieve a shipping method X
Update a locations of a shipping zone X
Shipping zone methods (v2) Include a shipping method to a shipping zone X
Update a shipping method of a shipping zone X
Delete a shipping method of a shipping zone X
Shipping zones (v2) List all shipping zones X
Retrieve a shipping zone X
Create a shipping zone X
Update a shipping zone X
Delete a shipping zone X
System status (v2) List all system status items X
System status tools (v2) List all tools from system status X
Retrieve a tool from system status X
Run a tool from system status X
Tax classes (v2) List all tax classes X
Create a tax class X
Delete a tax class X
Tax rates (v2) List all tax rates X
Retrieve a tax rate X
Create a tax rate X
Update a tax rate X
Delete a tax rate X
Batch update tax rates X
Webhooks (v2) List all webhooks X
Retrieve a webhook X
List all webhook deliveries X
Retrieve webhook delivery X
Create a webhook X
Update a webhook X
Delete a webhook X
Batch update webhooks X

API v3 version operations

Resource API endpoint Export Import
Coupons (v3) List all coupons X
Retrieve a coupon X
Create a coupon X
Update a coupon X
Delete a coupon X
Batch update coupons X
Customers (v3) List all customers X
Retrieve a customer X
Retrieve customer downloads X
Create a customer X
Update a customer X
Delete a customer X
Batch update customers X
Data (v3) List all data X
List all continents X
Retrieve continent data X
List all countries X
Retrieve country data X
List all currencies X
Retrieve currency data X
Retrieve current currency X
Order actions (v3) Send order details to customer X
Send order notification email to customer X
Get available email templates for an order X
Order notes (v3) List all order notes X
Retrieve an order note X
Create an order note X
Delete an order note X
Order refunds (v3) List all refunds X
Retrieve a refund X
Create a refund X
Delete a refund X
Orders (v3) List all orders X
Retrieve an order X
Create an order X
Update an order X
Delete an order X
Batch update orders X
Payment gateways (v3) List all payment gateways X
Retrieve a payment gateway X
Update a payment gateway X
Product attribute terms (v3) List all attribute terms X
Retrieve an attribute term X
Create an attribute term X
Update an attribute term X
Delete an attribute term X
Batch update attribute terms X
Product attributes (v3) List all product attributes X
Retrieve a product attribute X
Create a product attribute X
Update a product attribute X
Delete a product attribute X
Batch update product attributes X
Product categories (v3) List all product categories X
Retrieve a product category X
Create a product category X
Update a product category X
Delete a product category X
Batch update product categories X
Product custom fields (v3) Retrieve product custom field names X
Product reviews (v3) List all product reviews X
Retrieve product reviews X
Create a product review X
Update a product review X
Delete a product review X
Batch update product reviews X
Product shipping classes (v3) List all shipping classes X
Retrieve a shipping class X
Create a shipping class X
Update a shipping class X
Delete a shipping class X
Batch update shipping classes X
Product tags (v3) List all product tags X
Retrieve a product tag X
Create a product tag X
Update a product tag X
Delete a product tag X
Batch update product tags X
Product variations (v3) List all product variations X
Retrieve a product variation X
Create a product variation X
Update a product variation X
Delete a product variation X
Batch update product variations X
Products (v3) List all products X
Retrieve a product X
Create a product X
Update a product X
Delete a product X
Batch update product X
Refunds (v3) Retrieve a list of refunds X
Reports (v3) List all reports X
Retrieve sales report X
Retrieve top sellers report X
Retrieve coupons total X
Retrieve customers total X
Retrieve order totals X
Retrieve products totals X
Retrieve reviews totals X
Setting options (v3) List all setting options X
Retrieve a setting option X
Update a setting option X
Batch update setting options X
Settings (v3) List all settings groups X
Shipping methods (v3) List all shipping methods X
Retrieve a shipping method X
Shipping zone locations (v3) List all locations of a shipping zone X
Update a locations of a shipping zone X
Shipping zone methods (v3) List all shipping methods from a shipping zone X
Retrieve a shipping method from a shipping zone X
Include a shipping method to a shipping zone X
Update a shipping method of a shipping zone X
Delete a shipping method of a shipping zone X
Shipping zones (v3) List all shipping zones X
Retrieve a shipping zone X
Create a shipping zone X
Update a shipping zone X
Delete a shipping zone X
System status (v3) List all system status items X
System status tools (v3) List all tools from system status X
Retrieve a tool from system status X
Run a tool from system status X
Tax classes (v3) List all tax classes X
Create a tax class X
Delete a tax class X
Tax rates (v3) List all tax rates X
Retrieve a tax rate X
Create a tax rate X
Update a tax rate X
Delete a tax rate X
Batch update tax rates X
Webhooks (v3) List all webhooks X
Retrieve a webhook X
Create a webhook X
Update a webhook X
Delete a webhook X
Batch update webhooks X

Available DI objects

The following objects are available when using WooCommerce as a source in Celigo Data Integration (DI).

Primary key: All WooCommerce DI endpoints use id as the primary key. WooCommerce assigns a numeric id to every resource object.

Note: WooCommerce uses a soft-delete mechanism. When a record is deleted, its status is changed to Trash rather than being permanently removed. These records remain accessible through the API using ?status=trash. Celigo syncs the data returned by the source as-is.

Object API endpoint Available extract modes Delta field
Coupons List all coupons Full, Incremental modified_after
Customers List all customers Full
Orders List all orders Full, Incremental modified_after
Payment gateways List all payment gateways Full
Product attributes List all product attributes Full
Product categories List all product categories Full
Product reviews List all product reviews Full, Incremental after
Product shipping classes List all shipping classes Full
Product tags List all product tags Full
Products List all products Full, Incremental modified_after
Refunds Retrieve a list of refunds Full, Incremental after
Settings List all settings groups Full
Shipping methods List all shipping methods Full
Shipping zones List all shipping zones Full
Tax rates List all tax rates Full

Response schemas

Click an object below to view its response fields and delta configuration.

Coupons — List all coupons

Delta configuration: use it to request incremental data.

Setting Value
Delta filter modified_after = {{{lastExportDateTime}}}
Additional parameters dates_are_gmt = true
Date format YYYY-MM-DDTHH:mm:ss

Response schema:

Field Type
id number (Primary key)
code string
amount string
date_created string
date_created_gmt string
date_modified string
date_modified_gmt string
discount_type string
description string
date_expires string
date_expires_gmt string
usage_count number
individual_use boolean
product_ids numberarray
excluded_product_ids numberarray
usage_limit number
usage_limit_per_user number
limit_usage_to_x_items number
free_shipping boolean
product_categories numberarray
excluded_product_categories numberarray
exclude_sale_items boolean
minimum_amount string
maximum_amount string
email_restrictions stringarray
used_by stringarray
meta_data objectarray
meta_data.id number
meta_data.key string
meta_data.value string
Customers — List all customers

Response schema:

Field Type
id number (Primary key)
date_created string
date_created_gmt string
date_modified string
date_modified_gmt string
email string
first_name string
last_name string
role string
username string
billing object
billing.first_name string
billing.last_name string
billing.company string
billing.address_1 string
billing.address_2 string
billing.city string
billing.state string
billing.postcode string
billing.country string
billing.email string
billing.phone string
shipping object
shipping.first_name string
shipping.last_name string
shipping.company string
shipping.address_1 string
shipping.address_2 string
shipping.city string
shipping.state string
shipping.postcode string
shipping.country string
shipping.phone string
is_paying_customer boolean
avatar_url string
meta_data objectarray
meta_data.id number
meta_data.key string
meta_data.value string
Orders — List all orders

Delta configuration: use it to request incremental data.

Setting Value
Delta filter modified_after = {{{lastExportDateTime}}}
Additional parameters dates_are_gmt = true
Date format YYYY-MM-DDTHH:mm:ss

Response schema:

Field Type
id number (Primary key)
parent_id number
number string
order_key string
created_via string
version string
status string
currency string
date_created string
date_created_gmt string
date_modified string
date_modified_gmt string
discount_total string
discount_tax string
shipping_total string
shipping_tax string
cart_tax string
total string
total_tax string
prices_include_tax boolean
customer_id number
customer_ip_address string
customer_user_agent string
customer_note string
billing object
billing.first_name string
billing.last_name string
billing.company string
billing.address_1 string
billing.address_2 string
billing.city string
billing.state string
billing.postcode string
billing.country string
billing.email string
billing.phone string
shipping object
shipping.first_name string
shipping.last_name string
shipping.company string
shipping.address_1 string
shipping.address_2 string
shipping.city string
shipping.state string
shipping.postcode string
shipping.country string
shipping.phone string
payment_method string
payment_method_title string
transaction_id string
date_paid string
date_paid_gmt string
date_completed string
date_completed_gmt string
cart_hash string
meta_data objectarray
meta_data.id number
meta_data.key string
meta_data.value string
line_items objectarray
line_items.id number
line_items.name string
line_items.parent_name string
line_items.product_id number
line_items.variation_id number
line_items.quantity number
line_items.tax_class string
line_items.subtotal string
line_items.subtotal_tax string
line_items.total string
line_items.total_tax string
line_items.taxes objectarray
line_items.taxes.id number
line_items.taxes.total string
line_items.taxes.subtotal string
line_items.meta_data objectarray
line_items.meta_data.id number
line_items.meta_data.key string
line_items.meta_data.value string
line_items.sku string
line_items.price string
tax_lines objectarray
tax_lines.id number
tax_lines.rate_code string
tax_lines.rate_id number
tax_lines.label string
tax_lines.compound boolean
tax_lines.tax_total string
tax_lines.shipping_tax_total string
tax_lines.meta_data objectarray
tax_lines.meta_data.id number
tax_lines.meta_data.key string
tax_lines.meta_data.value string
shipping_lines objectarray
shipping_lines.id number
shipping_lines.method_title string
shipping_lines.method_id string
shipping_lines.instance_id string
shipping_lines.total string
shipping_lines.total_tax string
shipping_lines.taxes objectarray
shipping_lines.taxes.id number
shipping_lines.taxes.total string
shipping_lines.taxes.subtotal string
shipping_lines.meta_data objectarray
shipping_lines.meta_data.id number
shipping_lines.meta_data.key string
shipping_lines.meta_data.value string
fee_lines objectarray
fee_lines.id number
fee_lines.name string
fee_lines.tax_class string
fee_lines.tax_status string
fee_lines.total string
fee_lines.total_tax string
fee_lines.taxes objectarray
fee_lines.taxes.id number
fee_lines.taxes.total string
fee_lines.taxes.subtotal string
fee_lines.meta_data objectarray
fee_lines.meta_data.id number
fee_lines.meta_data.key string
fee_lines.meta_data.value string
coupon_lines objectarray
coupon_lines.id number
coupon_lines.code string
coupon_lines.discount string
coupon_lines.discount_tax string
coupon_lines.meta_data objectarray
coupon_lines.meta_data.id number
coupon_lines.meta_data.key string
coupon_lines.meta_data.value string
refunds objectarray
refunds.id number
refunds.reason string
refunds.total string
Payment gateways — List all payment gateways

Response schema:

Field Type
id string (Primary key)
title string
description string
order number
enabled boolean
method_title string
method_description string
method_supports stringarray
Product attributes — List all product attributes

Response schema:

Field Type
id number (Primary key)
name string
slug string
type string
order_by string
has_archives boolean
Product categories — List all product categories

Response schema:

Field Type
id number (Primary key)
name string
slug string
parent number
description string
display string
image object
image.id number
image.date_created string
image.date_created_gmt string
image.date_modified string
image.date_modified_gmt string
image.src string
image.name string
image.alt string
menu_order number
count number
Product reviews — List all product reviews

Delta configuration: use it to request incremental data.

Setting Value
Delta filter after = {{{lastExportDateTime}}}
Additional parameters dates_are_gmt = true
Date format YYYY-MM-DDTHH:mm:ss

Response schema:

Field Type
id number (Primary key)
date_created string
date_created_gmt string
product_id number
status string
reviewer string
reviewer_email string
review string
rating number
verified boolean
Product shipping classes — List all shipping classes

Response schema:

Field Type
id number (Primary key)
name string
slug string
description string
count number
Product tags — List all product tags

Response schema:

Field Type
id number (Primary key)
name string
slug string
description string
count number
Products — List all products

Delta configuration: use it to request incremental data.

Setting Value
Delta filter modified_after = {{{lastExportDateTime}}}
Additional parameters dates_are_gmt = true
Date format YYYY-MM-DDTHH:mm:ss

Response schema:

Field Type
id number (Primary key)
name string
slug string
permalink string
date_created string
date_created_gmt string
date_modified string
date_modified_gmt string
type string
status string
featured boolean
catalog_visibility string
description string
short_description string
sku string
price string
regular_price string
sale_price string
date_on_sale_from string
date_on_sale_from_gmt string
date_on_sale_to string
date_on_sale_to_gmt string
price_html string
on_sale boolean
purchasable boolean
total_sales number
virtual boolean
downloadable boolean
downloads objectarray
downloads.id string
downloads.name string
downloads.file string
download_limit number
download_expiry number
external_url string
button_text string
tax_status string
tax_class string
manage_stock boolean
stock_quantity number
stock_status string
backorders string
backorders_allowed boolean
backordered boolean
sold_individually boolean
weight string
dimensions object
dimensions.length string
dimensions.width string
dimensions.height string
shipping_required boolean
shipping_taxable boolean
shipping_class string
shipping_class_id number
reviews_allowed boolean
average_rating string
rating_count number
related_ids numberarray
upsell_ids numberarray
cross_sell_ids numberarray
parent_id number
purchase_note string
categories objectarray
categories.id number
categories.name string
categories.slug string
tags objectarray
tags.id number
tags.name string
tags.slug string
images objectarray
images.id number
images.date_created string
images.date_created_gmt string
images.date_modified string
images.date_modified_gmt string
images.src string
images.name string
images.alt string
attributes objectarray
attributes.id number
attributes.name string
attributes.position number
attributes.visible boolean
attributes.variation boolean
attributes.options stringarray
default_attributes objectarray
default_attributes.id number
default_attributes.name string
default_attributes.option string
variations numberarray
grouped_products numberarray
menu_order number
meta_data objectarray
meta_data.id number
meta_data.key string
meta_data.value string
Refunds — Retrieve a list of refunds

Delta configuration: use it to request incremental data.

Setting Value
Delta filter after = {{{lastExportDateTime}}}
Additional parameters dates_are_gmt = true
Date format YYYY-MM-DDTHH:mm:ss

Response schema:

Field Type
id number (Primary key)
parent_id number
date_created string
date_created_gmt string
amount string
reason string
refunded_by number
refunded_payment boolean
meta_data objectarray
meta_data.id number
meta_data.key string
meta_data.value string
line_items objectarray
line_items.id number
line_items.name string
line_items.parent_name string
line_items.product_id number
line_items.variation_id number
line_items.quantity number
line_items.tax_class string
line_items.subtotal string
line_items.subtotal_tax string
line_items.total string
line_items.total_tax string
line_items.taxes objectarray
line_items.taxes.id number
line_items.taxes.total string
line_items.taxes.subtotal string
line_items.meta_data objectarray
line_items.meta_data.id number
line_items.meta_data.key string
line_items.meta_data.value string
line_items.sku string
line_items.price string
Settings — List all settings groups

Response schema:

Field Type
id string (Primary key)
label string
description string
parent_id string
sub_groups stringarray
Shipping methods — List all shipping methods

Response schema:

Field Type
id string (Primary key)
title string
description string
Shipping zones — List all shipping zones

Response schema:

Field Type
id number (Primary key)
name string
order number
Tax rates — List all tax rates

Response schema:

Field Type
id number (Primary key)
country string
state string
postcode string
city string
rate string
name string
priority number
compound boolean
shipping boolean
order number
class string