About this integration
Ecommerce platform for products, orders, customers, and payments. This integration exposes its full API as workflow modules.
The integration includes 3 triggers, 70 search modules and 72 actions. Connections use basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for Store Host, Consumer Key, Consumer Secret, and Query String Auth.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
Store HostRequired | text | Store hostname only — no |
Consumer KeyRequired | password | WooCommerce → Settings → Advanced → REST API. Consumer key ( |
Consumer SecretRequired | password | Consumer secret ( |
Query String Auth | boolean | When the host drops the Authorization header ( |
Use it in workflow automation
Start with Watch Events, then add Create Coupon.
Triggers, searches and actions
Browse every WooCommerce module field below: 3 triggers, 70 searchs, and 72 actions you can drop onto the canvas.
Triggers
This integration includes 3 triggers — start a workflow the moment something changes in the app.
- Watch Events
- Watch New Orders
- Watch Updated Orders
Searches
Use any of 70 search modules to retrieve records without leaving the workflow canvas.
- Get API Index
- Get Attributes Totals Report
- Get Categories Totals Report
- Get Continent
- Get Country
Actions
This integration includes 72 action modules — create, update, or delete records as part of any workflow.
- Create Coupon
- Create Customer
- Create Order
- Create Order Note
- Create Order Refund
Explore the fields available for each WooCommerce trigger, search, and action.
Triggers
| Field | Type |
|---|---|
Id | number |
Parent Id | number |
Number | text |
Order Key | text |
Created Via | text |
Version | text |
Status | text |
Currency | text |
| Field | Type |
|---|---|
Id | number |
Parent Id | number |
Number | text |
Order Key | text |
Created Via | text |
Version | text |
Status | text |
Currency | text |
| Field | Type |
|---|---|
Id | number |
Parent Id | number |
Number | text |
Order Key | text |
Created Via | text |
Version | text |
Status | text |
Currency | text |
Searches
| Field | Type |
|---|---|
Namespace | text |
Routes | object |
/Wc/V3 | object |
/Wc/V3/Orders | object |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Slug | text |
Name | text |
Total | number |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Slug | text |
Name | text |
Total | number |
| Field | Type |
|---|---|
CodeRequired | text |
| Field | Type |
|---|---|
Code | text |
Name | text |
Countries | array |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
CountryRequired | choice |
| Field | Type |
|---|---|
Code | text |
Name | text |
States | array |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
CouponRequired | choice |
| Field | Type |
|---|---|
Id | number |
Code | text |
Amount | text |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Discount Type | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Slug | text |
Name | text |
Total | number |
| Field | Type |
|---|---|
CurrencyRequired | choice |
| Field | Type |
|---|---|
Code | text |
Name | text |
Symbol | text |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Code | text |
Name | text |
Symbol | text |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
CustomerRequired | choice |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Email | text |
First Name | text |
Last Name | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Slug | text |
Name | text |
Total | number |
| Field | Type |
|---|---|
OrderRequired | choice |
| Field | Type |
|---|---|
Id | number |
Parent Id | number |
Number | text |
Order Key | text |
Created Via | text |
Version | text |
Status | text |
Currency | text |
| Field | Type |
|---|---|
OrderRequired | choice |
| Field | Type |
|---|---|
Id | number |
Author | text |
Date Created | date |
Date Created Gmt | date |
Note | text |
Customer Note | boolean |
Links | object |
Self | array |
Collection | array |
Up | array |
| Field | Type |
|---|---|
OrderRequired | choice |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Amount | text |
Reason | text |
Refunded By | number |
Refunded Payment | boolean |
Meta Data | array |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Slug | text |
Name | text |
Total | number |
| Field | Type |
|---|---|
Payment GatewayRequired | choice |
| Field | Type |
|---|---|
Id | text |
Title | text |
Description | text |
Order | number |
Enabled | boolean |
Method Title | text |
Method Description | text |
Method Supports | array |
| Field | Type |
|---|---|
ProductRequired | choice |
Image Size | text |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Permalink | text |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
| Field | Type |
|---|---|
Product AttributeRequired | choice |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Type | text |
Order By | text |
Has Archives | boolean |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Product AttributeRequired | choice |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Description | text |
Menu Order | number |
Count | number |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Product CategoryRequired | choice |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Parent | number |
Description | text |
Display | text |
Image | object |
Id | number |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Src | text |
Name | text |
Alt | text |
Menu Order | number |
| Field | Type |
|---|---|
Product ReviewRequired | choice |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Product Id | number |
Status | text |
Reviewer | text |
Reviewer Email | text |
Review | text |
| Field | Type |
|---|---|
Product Shipping ClassRequired | choice |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Description | text |
Count | number |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Slug | text |
Name | text |
Total | number |
| Field | Type |
|---|---|
Product TagRequired | choice |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Description | text |
Count | number |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
ProductRequired | choice |
Image Size | text |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Description | text |
Permalink | text |
Sku | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Slug | text |
Name | text |
Total | number |
| Field | Type |
|---|---|
Period | choice |
Date Min | text |
Date Max | text |
Context | choice |
| Field | Type |
|---|---|
Total Sales | text |
Net Sales | text |
Average Sales | text |
Total Orders | number |
Total Items | number |
Total Tax | text |
Total Shipping | text |
Total Refunds | number |
| Field | Type |
|---|---|
Settings GroupRequired | choice |
| Field | Type |
|---|---|
Id | text |
Label | text |
Description | text |
Type | text |
Default | text |
Options | object |
All | text |
All Except | text |
Specific | text |
Tip | text |
Value | text |
| Field | Type |
|---|---|
Shipping MethodRequired | choice |
| Field | Type |
|---|---|
Id | text |
Title | text |
Description | text |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Shipping ZoneRequired | choice |
| Field | Type |
|---|---|
Id | number |
Name | text |
Order | number |
Links | object |
Self | array |
Collection | array |
Describedby | array |
| Field | Type |
|---|---|
Shipping ZoneRequired | choice |
| Field | Type |
|---|---|
Instance Id | number |
Title | text |
Order | number |
Enabled | boolean |
Method Id | text |
Method Title | text |
Method Description | text |
Settings | object |
| Field | Type |
|---|---|
Context | choice |
| Field | Type |
|---|---|
Environment | object |
Home Url | text |
Site Url | text |
Version | text |
Wp Version | text |
Wp Multisite | boolean |
Language | text |
Php Version | text |
Database | object |
Wc Database Version | text |
Database Prefix | text |
Active Plugins | array |
Theme | object |
Name | text |
Version | text |
Is Child Theme | boolean |
Settings | object |
Api Enabled | boolean |
Currency | text |
Currency Symbol | text |
Security | object |
Secure Connection | boolean |
Hide Errors | boolean |
Pages | array |
| Field | Type |
|---|---|
System Status ToolRequired | choice |
| Field | Type |
|---|---|
Id | text |
Name | text |
Action | text |
Description | text |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Slug | text |
Name | text |
Total | number |
| Field | Type |
|---|---|
Tax RateRequired | choice |
| Field | Type |
|---|---|
Id | number |
Country | text |
State | text |
Postcode | text |
City | text |
Postcodes | array |
Cities | array |
Rate | text |
| Field | Type |
|---|---|
Period | choice |
Date Min | text |
Date Max | text |
Context | choice |
Limit | number |
| Field | Type |
|---|---|
Title | text |
Product Id | number |
Quantity | number |
Links | object |
About | array |
Product | array |
| Field | Type |
|---|---|
WebhookRequired | choice |
| Field | Type |
|---|---|
Id | number |
Name | text |
Status | text |
Topic | text |
Resource | text |
Event | text |
Hooks | array |
Delivery Url | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Code | text |
Name | text |
Countries | array |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Code | text |
Name | text |
States | array |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Search | text |
After | date |
Before | date |
Modified After | date |
Modified Before | date |
Dates Are GMT | boolean |
Exclude | choice |
Include | choice |
| Field | Type |
|---|---|
Id | number |
Code | text |
Amount | text |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Discount Type | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Code | text |
Name | text |
Symbol | text |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
CustomerRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Download Id | text |
Download Url | text |
Product Id | number |
Product Name | text |
Download Name | text |
Order Id | number |
Order Key | text |
Downloads Remaining | text |
| Field | Type |
|---|---|
Search | text |
Exclude | choice |
Include | choice |
Order | choice |
Order By | choice |
Email | |
Role | choice |
Context | choice |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Email | text |
First Name | text |
Last Name | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Slug | text |
Description | text |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
OrderRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Id | text |
Title | text |
Description | text |
| Field | Type |
|---|---|
OrderRequired | choice |
Context | choice |
Type | choice |
Limit | number |
| Field | Type |
|---|---|
Id | number |
Author | text |
Date Created | date |
Date Created Gmt | date |
Note | text |
Customer Note | boolean |
Links | object |
Self | array |
Collection | array |
Up | array |
| Field | Type |
|---|---|
OrderRequired | choice |
Search | text |
After | date |
Before | date |
Dates Are GMT | boolean |
Exclude | choice |
Include | choice |
Order | choice |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Amount | text |
Reason | text |
Refunded By | number |
Refunded Payment | boolean |
Meta Data | array |
| Field | Type |
|---|---|
Search | text |
After | date |
Before | date |
Modified After | date |
Modified Before | date |
Dates Are GMT | boolean |
Exclude | choice |
Include | choice |
| Field | Type |
|---|---|
Id | number |
Parent Id | number |
Number | text |
Order Key | text |
Created Via | text |
Version | text |
Status | text |
Currency | text |
| Field | Type |
|---|---|
Context | choice |
Limit | number |
| Field | Type |
|---|---|
Id | text |
Title | text |
Description | text |
Order | number |
Enabled | boolean |
Method Title | text |
Method Description | text |
Method Supports | array |
| Field | Type |
|---|---|
Context | choice |
Limit | number |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Type | text |
Order By | text |
Has Archives | boolean |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Product AttributeRequired | choice |
Search | text |
Exclude | choice |
Include | choice |
Order | choice |
Order By | choice |
Hide Empty | boolean |
Product | choice |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Description | text |
Menu Order | number |
Count | number |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Search | text |
Exclude | choice |
Include | choice |
Order | choice |
Order By | choice |
Hide Empty | boolean |
Product | choice |
Slug | text |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Parent | number |
Description | text |
Display | text |
Image | object |
Id | number |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Src | text |
Name | text |
Alt | text |
Menu Order | number |
| Field | Type |
|---|---|
Search | text |
Order | choice |
Context | choice |
Limit | number |
| Field | Type |
|---|---|
Name | text |
| Field | Type |
|---|---|
Search | text |
After | date |
Before | date |
Dates Are GMT | boolean |
Exclude | choice |
Include | choice |
Order | choice |
Order By | choice |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Product Id | number |
Status | text |
Reviewer | text |
Reviewer Email | text |
Review | text |
| Field | Type |
|---|---|
Search | text |
After | date |
Before | date |
Modified After | date |
Modified Before | date |
Dates Are GMT | boolean |
Exclude | choice |
Include | choice |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Permalink | text |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
| Field | Type |
|---|---|
Search | text |
Exclude | choice |
Include | choice |
Order | choice |
Order By | choice |
Hide Empty | boolean |
Product | choice |
Slug | text |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Description | text |
Count | number |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Search | text |
Exclude | choice |
Include | choice |
Order | choice |
Order By | choice |
Hide Empty | boolean |
Product | choice |
Slug | text |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Description | text |
Count | number |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
ProductRequired | choice |
Search | text |
After | date |
Before | date |
Dates Are GMT | boolean |
Exclude | choice |
Include | choice |
Order | choice |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Description | text |
Permalink | text |
Sku | text |
| Field | Type |
|---|---|
Search | text |
After | date |
Before | date |
Dates Are GMT | boolean |
Exclude | array |
ID | number |
Include | array |
ID | number |
Order | choice |
Order By | choice |
| Field | Type |
|---|---|
Id | number |
Parent Id | number |
Date Created | date |
Date Created Gmt | date |
Amount | text |
Reason | text |
Refunded By | number |
Refunded Payment | boolean |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Slug | text |
Description | text |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Settings GroupRequired | choice |
Context | choice |
Limit | number |
| Field | Type |
|---|---|
Id | text |
Label | text |
Description | text |
Type | text |
Default | text |
Options | object |
All | text |
All Except | text |
Specific | text |
Tip | text |
Value | text |
| Field | Type |
|---|---|
Context | choice |
Limit | number |
| Field | Type |
|---|---|
Id | text |
Label | text |
Description | text |
Parent Id | text |
Sub Groups | array |
Links | object |
Options | array |
| Field | Type |
|---|---|
Context | choice |
Limit | number |
| Field | Type |
|---|---|
Id | text |
Title | text |
Description | text |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Shipping ZoneRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Code | text |
Type | text |
Links | object |
Collection | array |
Describes | array |
| Field | Type |
|---|---|
Shipping ZoneRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Instance Id | number |
Title | text |
Order | number |
Enabled | boolean |
Method Id | text |
Method Title | text |
Method Description | text |
Settings | object |
| Field | Type |
|---|---|
Context | choice |
Limit | number |
| Field | Type |
|---|---|
Id | number |
Name | text |
Order | number |
Links | object |
Self | array |
Collection | array |
Describedby | array |
| Field | Type |
|---|---|
Context | choice |
Limit | number |
| Field | Type |
|---|---|
Id | text |
Name | text |
Action | text |
Description | text |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Context | choice |
Limit | number |
| Field | Type |
|---|---|
Slug | text |
Name | text |
Links | object |
Collection | array |
| Field | Type |
|---|---|
Order | choice |
Order By | choice |
Tax Class | choice |
Context | choice |
Limit | number |
| Field | Type |
|---|---|
Id | number |
Country | text |
State | text |
Postcode | text |
City | text |
Postcodes | array |
Cities | array |
Rate | text |
| Field | Type |
|---|---|
Search | text |
After | date |
Before | date |
Dates Are GMT | boolean |
Exclude | choice |
Include | choice |
Order | choice |
Order By | choice |
| Field | Type |
|---|---|
Id | number |
Name | text |
Status | text |
Topic | text |
Resource | text |
Event | text |
Hooks | array |
Delivery Url | text |
Actions
| Field | Type |
|---|---|
CodeRequired | text |
Amount | text |
Discount Type | choice |
Description | text |
Date Expires | date |
Date Expires GMT | date |
Individual Use | boolean |
Product IDs | choice |
| Field | Type |
|---|---|
Id | number |
Code | text |
Amount | text |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Discount Type | text |
| Field | Type |
|---|---|
EmailRequired | |
First Name | text |
Last Name | text |
Username | text |
Password | secret |
Billing | object |
First Name | text |
Last Name | text |
Company | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Postcode | text |
Country | text |
Email | |
Shipping | object |
First Name | text |
Last Name | text |
Company | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Postcode | text |
Country | text |
Meta Data | array |
Item | object |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Email | text |
First Name | text |
Last Name | text |
| Field | Type |
|---|---|
Customer | choice |
Status | choice |
Parent ID | number |
Created Via | text |
Currency | text |
Customer Note | text |
Billing | object |
First Name | text |
Last Name | text |
Company | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Postcode | text |
Country | text |
Email | |
Shipping | object |
First Name | text |
Last Name | text |
Company | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Postcode | text |
Country | text |
| Field | Type |
|---|---|
Id | number |
Parent Id | number |
Number | text |
Order Key | text |
Created Via | text |
Version | text |
Status | text |
Currency | text |
| Field | Type |
|---|---|
OrderRequired | choice |
NoteRequired | text |
Customer Note | boolean |
Added By User | boolean |
| Field | Type |
|---|---|
Id | number |
Author | text |
Date Created | date |
Date Created Gmt | date |
Note | text |
Customer Note | boolean |
Links | object |
Self | array |
Collection | array |
Up | array |
| Field | Type |
|---|---|
OrderRequired | choice |
Amount | text |
Reason | text |
Refunded By | number |
API Refund | boolean |
API Restock | boolean |
Compute Totals | boolean |
Line Items | array |
Line Item | object |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Amount | text |
Reason | text |
Refunded By | number |
Refunded Payment | boolean |
Meta Data | array |
| Field | Type |
|---|---|
NameRequired | text |
Slug | text |
Type | choice |
Status | choice |
Featured | boolean |
Catalog Visibility | choice |
Description | text |
Short Description | text |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Permalink | text |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
| Field | Type |
|---|---|
NameRequired | text |
Slug | text |
Type | text |
Order By | choice |
Has Archives | boolean |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Type | text |
Order By | text |
Has Archives | boolean |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Product AttributeRequired | choice |
NameRequired | text |
Slug | text |
Description | text |
Menu Order | number |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Description | text |
Menu Order | number |
Count | number |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
NameRequired | text |
Slug | text |
Parent | choice |
Description | text |
Display | choice |
Image | object |
Id | number |
Src | text |
Name | text |
Alt | text |
Menu Order | number |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Parent | number |
Description | text |
Display | text |
Image | object |
Id | number |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Src | text |
Name | text |
Alt | text |
Menu Order | number |
| Field | Type |
|---|---|
ProductRequired | choice |
ReviewerRequired | text |
Reviewer EmailRequired | |
ReviewRequired | text |
Status | choice |
Rating | number |
Verified | boolean |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Product Id | number |
Status | text |
Reviewer | text |
Reviewer Email | text |
Review | text |
| Field | Type |
|---|---|
NameRequired | text |
Slug | text |
Description | text |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Description | text |
Count | number |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
NameRequired | text |
Slug | text |
Description | text |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Description | text |
Count | number |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
ProductRequired | choice |
Description | text |
Sku | text |
Global Unique Id | text |
Regular Price | text |
Sale Price | text |
Date On Sale From | date |
Date On Sale From Gmt | date |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Description | text |
Permalink | text |
Sku | text |
| Field | Type |
|---|---|
NameRequired | text |
Order | number |
| Field | Type |
|---|---|
Id | number |
Name | text |
Order | number |
Links | object |
Self | array |
Collection | array |
Describedby | array |
| Field | Type |
|---|---|
Shipping ZoneRequired | choice |
Shipping MethodRequired | choice |
Order | number |
Enabled | boolean |
Settings | text |
| Field | Type |
|---|---|
Instance Id | number |
Title | text |
Order | number |
Enabled | boolean |
Method Id | text |
Method Title | text |
Method Description | text |
Settings | object |
| Field | Type |
|---|---|
NameRequired | text |
| Field | Type |
|---|---|
Slug | text |
Name | text |
Links | object |
Collection | array |
| Field | Type |
|---|---|
Country | choice |
State | text |
Postcode | text |
City | text |
Postcodes | array |
Postcode | text |
Cities | array |
City | text |
Rate | text |
Name | text |
| Field | Type |
|---|---|
Id | number |
Country | text |
State | text |
Postcode | text |
City | text |
Postcodes | array |
Cities | array |
Rate | text |
| Field | Type |
|---|---|
CouponRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Id | number |
Code | text |
Amount | text |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Discount Type | text |
| Field | Type |
|---|---|
CustomerRequired | choice |
ForceRequired | boolean |
Reassign | choice |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Email | text |
First Name | text |
Last Name | text |
| Field | Type |
|---|---|
OrderRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Id | number |
Parent Id | number |
Number | text |
Order Key | text |
Created Via | text |
Version | text |
Status | text |
Currency | text |
| Field | Type |
|---|---|
OrderRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Id | number |
Author | text |
Date Created | date |
Date Created Gmt | date |
Note | text |
Customer Note | boolean |
Links | object |
Self | array |
Collection | array |
Up | array |
| Field | Type |
|---|---|
OrderRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Amount | text |
Reason | text |
Refunded By | number |
Refunded Payment | boolean |
Meta Data | array |
| Field | Type |
|---|---|
ProductRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Permalink | text |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
| Field | Type |
|---|---|
Product AttributeRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Type | text |
Order By | text |
Has Archives | boolean |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Product AttributeRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Description | text |
Menu Order | number |
Count | number |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Product CategoryRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Parent | number |
Description | text |
Display | text |
Image | object |
Id | number |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Src | text |
Name | text |
Alt | text |
Menu Order | number |
| Field | Type |
|---|---|
Product ReviewRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Product Id | number |
Status | text |
Reviewer | text |
Reviewer Email | text |
Review | text |
| Field | Type |
|---|---|
Product Shipping ClassRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Description | text |
Count | number |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Product TagRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Description | text |
Count | number |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
ProductRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Description | text |
Permalink | text |
Sku | text |
| Field | Type |
|---|---|
Shipping ZoneRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Id | number |
Name | text |
Order | number |
Links | object |
Self | array |
Collection | array |
Describedby | array |
| Field | Type |
|---|---|
Shipping ZoneRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Instance Id | number |
Title | text |
Order | number |
Enabled | boolean |
Method Id | text |
Method Title | text |
Method Description | text |
Settings | object |
| Field | Type |
|---|---|
Tax ClassRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Slug | text |
Name | text |
Links | object |
Collection | array |
| Field | Type |
|---|---|
Tax RateRequired | choice |
ForceRequired | boolean |
| Field | Type |
|---|---|
Id | number |
Country | text |
State | text |
Postcode | text |
City | text |
Postcodes | array |
Cities | array |
Rate | text |
| Field | Type |
|---|---|
ProductRequired | choice |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Permalink | text |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
| Field | Type |
|---|---|
OrderRequired | choice |
Amount | text |
Reason | text |
Refunded By | number |
API Refund | boolean |
API Restock | boolean |
Compute Totals | boolean |
Line Items | array |
Line Item | object |
| Field | Type |
|---|---|
Breakdown | object |
Products | text |
Shipping | text |
Fees | text |
Subtotal | text |
Tax | text |
Total | text |
Max Refundable | text |
| Field | Type |
|---|---|
System Status ToolRequired | choice |
ConfirmRequired | boolean |
| Field | Type |
|---|---|
Id | text |
Name | text |
Action | text |
Description | text |
Links | object |
Self | array |
Collection | array |
Success | boolean |
Message | text |
| Field | Type |
|---|---|
OrderRequired | choice |
Email | |
Force Email Update | boolean |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
OrderRequired | choice |
Email | |
Force Email Update | boolean |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
CouponRequired | choice |
Code | text |
Amount | text |
Discount Type | choice |
Description | text |
Date Expires | date |
Date Expires GMT | date |
Individual Use | boolean |
| Field | Type |
|---|---|
Id | number |
Code | text |
Amount | text |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Discount Type | text |
| Field | Type |
|---|---|
Create | array |
Item | object |
Update | array |
Item | object |
Delete | choice |
| Field | Type |
|---|---|
Create | array |
Update | array |
Delete | array |
| Field | Type |
|---|---|
CustomerRequired | choice |
Email | |
First Name | text |
Last Name | text |
Username | text |
Password | secret |
Billing | object |
First Name | text |
Last Name | text |
Company | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Postcode | text |
Country | text |
Email | |
Shipping | object |
First Name | text |
Last Name | text |
Company | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Postcode | text |
Country | text |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Email | text |
First Name | text |
Last Name | text |
| Field | Type |
|---|---|
Create | array |
Item | object |
Update | array |
Item | object |
Delete | choice |
| Field | Type |
|---|---|
Create | array |
Update | array |
Delete | array |
| Field | Type |
|---|---|
OrderRequired | choice |
Customer | choice |
Status | choice |
Parent ID | number |
Currency | text |
Customer Note | text |
Billing | object |
First Name | text |
Last Name | text |
Company | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Postcode | text |
Country | text |
Email | |
Shipping | object |
First Name | text |
Last Name | text |
Company | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Postcode | text |
Country | text |
| Field | Type |
|---|---|
Id | number |
Parent Id | number |
Number | text |
Order Key | text |
Created Via | text |
Version | text |
Status | text |
Currency | text |
| Field | Type |
|---|---|
Create | array |
Item | object |
Update | array |
Item | object |
Delete | choice |
| Field | Type |
|---|---|
Create | array |
Update | array |
Delete | array |
| Field | Type |
|---|---|
Payment GatewayRequired | choice |
Title | text |
Description | text |
Order | number |
Enabled | boolean |
Settings | text |
| Field | Type |
|---|---|
Id | text |
Title | text |
Description | text |
Order | number |
Enabled | boolean |
Method Title | text |
Method Description | text |
Method Supports | array |
| Field | Type |
|---|---|
ProductRequired | choice |
Name | text |
Slug | text |
Type | choice |
Status | choice |
Featured | boolean |
Catalog Visibility | choice |
Description | text |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Permalink | text |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
| Field | Type |
|---|---|
Product AttributeRequired | choice |
Name | text |
Slug | text |
Type | text |
Order By | choice |
Has Archives | boolean |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Type | text |
Order By | text |
Has Archives | boolean |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Create | array |
Item | object |
Update | array |
Item | object |
Delete | choice |
| Field | Type |
|---|---|
Create | array |
Update | array |
Delete | array |
| Field | Type |
|---|---|
Product AttributeRequired | choice |
Name | text |
Slug | text |
Description | text |
Menu Order | number |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Description | text |
Menu Order | number |
Count | number |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Product AttributeRequired | choice |
Create | array |
Item | object |
Update | array |
Item | object |
Delete | choice |
| Field | Type |
|---|---|
Create | array |
Update | array |
Delete | array |
| Field | Type |
|---|---|
Create | array |
Item | object |
Update | array |
Item | object |
Delete | choice |
| Field | Type |
|---|---|
Create | array |
Update | array |
Delete | array |
| Field | Type |
|---|---|
Product CategoryRequired | choice |
Name | text |
Slug | text |
Parent | choice |
Description | text |
Display | choice |
Image | object |
Id | number |
Src | text |
Name | text |
Alt | text |
Menu Order | number |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Parent | number |
Description | text |
Display | text |
Image | object |
Id | number |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Src | text |
Name | text |
Alt | text |
Menu Order | number |
| Field | Type |
|---|---|
Product ReviewRequired | choice |
Product | choice |
Reviewer | text |
Reviewer Email | |
Review | text |
Status | choice |
Rating | number |
Verified | boolean |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Product Id | number |
Status | text |
Reviewer | text |
Reviewer Email | text |
Review | text |
| Field | Type |
|---|---|
Create | array |
Item | object |
Update | array |
Item | object |
Delete | choice |
| Field | Type |
|---|---|
Create | array |
Update | array |
Delete | array |
| Field | Type |
|---|---|
Create | array |
Item | object |
Update | array |
Item | object |
Delete | choice |
| Field | Type |
|---|---|
Create | array |
Update | array |
Delete | array |
| Field | Type |
|---|---|
Product Shipping ClassRequired | choice |
Name | text |
Slug | text |
Description | text |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Description | text |
Count | number |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Create | array |
Item | object |
Update | array |
Item | object |
Delete | choice |
| Field | Type |
|---|---|
Create | array |
Update | array |
Delete | array |
| Field | Type |
|---|---|
Product TagRequired | choice |
Name | text |
Slug | text |
Description | text |
| Field | Type |
|---|---|
Id | number |
Name | text |
Slug | text |
Description | text |
Count | number |
Links | object |
Self | array |
Collection | array |
| Field | Type |
|---|---|
Create | array |
Item | object |
Update | array |
Item | object |
Delete | choice |
| Field | Type |
|---|---|
Create | array |
Update | array |
Delete | array |
| Field | Type |
|---|---|
ProductRequired | choice |
Description | text |
Sku | text |
Global Unique Id | text |
Regular Price | text |
Sale Price | text |
Date On Sale From | date |
Date On Sale From Gmt | date |
| Field | Type |
|---|---|
Id | number |
Date Created | date |
Date Created Gmt | date |
Date Modified | date |
Date Modified Gmt | date |
Description | text |
Permalink | text |
Sku | text |
| Field | Type |
|---|---|
ProductRequired | choice |
Create | array |
Item | object |
Update | array |
Item | object |
Delete | choice |
| Field | Type |
|---|---|
Create | array |
Update | array |
Delete | array |
| Field | Type |
|---|---|
Settings GroupRequired | choice |
Value | text |
| Field | Type |
|---|---|
Id | text |
Label | text |
Description | text |
Type | text |
Default | text |
Options | object |
All | text |
All Except | text |
Specific | text |
Tip | text |
Value | text |
| Field | Type |
|---|---|
Settings GroupRequired | choice |
Update | array |
Item | object |
| Field | Type |
|---|---|
Update | array |
| Field | Type |
|---|---|
Shipping ZoneRequired | choice |
Name | text |
Order | number |
| Field | Type |
|---|---|
Id | number |
Name | text |
Order | number |
Links | object |
Self | array |
Collection | array |
Describedby | array |
| Field | Type |
|---|---|
Shipping ZoneRequired | choice |
LocationsRequired | array |
Item | object |
| Field | Type |
|---|---|
Code | text |
Type | text |
Links | object |
Collection | array |
Describes | array |
| Field | Type |
|---|---|
Shipping ZoneRequired | choice |
Order | number |
Enabled | boolean |
Settings | text |
| Field | Type |
|---|---|
Instance Id | number |
Title | text |
Order | number |
Enabled | boolean |
Method Id | text |
Method Title | text |
Method Description | text |
Settings | object |
| Field | Type |
|---|---|
Tax RateRequired | choice |
Country | choice |
State | text |
Postcode | text |
City | text |
Postcodes | array |
Postcode | text |
Cities | array |
City | text |
Rate | text |
| Field | Type |
|---|---|
Id | number |
Country | text |
State | text |
Postcode | text |
City | text |
Postcodes | array |
Cities | array |
Rate | text |
| Field | Type |
|---|---|
Create | array |
Item | object |
Update | array |
Item | object |
Delete | choice |
| Field | Type |
|---|---|
Create | array |
Update | array |
Delete | array |
| Field | Type |
|---|---|
WebhookRequired | choice |
Name | text |
Status | choice |
Topic | choice |
Secret | text |
| Field | Type |
|---|---|
Id | number |
Name | text |
Status | text |
Topic | text |
Resource | text |
Event | text |
Hooks | array |
Delivery Url | text |
| Field | Type |
|---|---|
Update | array |
Item | object |
| Field | Type |
|---|---|
Update | array |