WooCommerce Connector Objects

Name	Description
Attributes	Retrieve and modify product attributes.
Categories	Retrieve product categories.
Continents	Retrieve continents.
Countries	Retrieve countries.
Coupons	Retrieve and modify coupons.
Currencies	Retrieve available currencies.
CustomerMetadata	Retrieve the metadata for each customer.
Customers	Retrieve and modify customers.
OrderCouponLines	Retrieve the coupon lines for an order.
OrderFeeLines	Retrieve the fee lines for an order.
OrderLineItems	Add, update and view the line items for an order.
OrderNotes	Retrieve and modify the notes for an order.
OrderRefundLineItems	Retrieve the line items for a refund.
OrderRefunds	Retrieve and modify order refunds.
Orders	Retrieve and modify orders.
OrderShippingLines	Retrieve the shipping lines for an order.
OrderTaxLines	Retrieve the tax lines for an order.
PaymentGateways	Retrieve and modify payment gateways.
ProductAttributes	Retrieve product attributes.
ProductAttributeTerms	Retrieve the terms for an attribute.
ProductCategories	Retrieve product categories.
ProductImages	Retrieve images for a product.
ProductReviews	Retrieve and modify products reviews.
Products	Retrieve and modify products.
ProductShippingClasses	Retrieve and modify product shipping classes.
ProductTags	Retrieve and modify product tags.
ProductVariations	Retrieve and modify product variations.
SalesReport	Executes a Sales report.
SettingGroups	Retrieve settings groups.
SettingOptions	View and manage settings options.
ShippingLocations	Retrieve shipping zone locations.
ShippingMethods	Retrieve shipping methods.
ShippingZoneMethods	Retrieve and modify shipping zone methods.
ShippingZones	Retrieve and modify shipping zones.
States	Retrieve shipping states.
SubscriptionCouponLines	Retrieve all subscription coupon lines. This view will show data only if WooCommerce Subscriptions Plugin is enabled.
SubscriptionFeeLines	Retrieve all subscription fee lines. This view will show data only if WooCommerce Subscriptions Plugin is enabled.
SubscriptionLineItems	Retrieve all subscription line items. This view will show data only if WooCommerce Subscriptions Plugin is enabled.
SubscriptionNotes	Retrieve all subscription notes. This table will show data only if WooCommerce Subscriptions Plugin is enabled.
SubscriptionOrders	Retrieve all subscription orders. This view will show data only if WooCommerce Subscriptions Plugin is enabled.
Subscriptions	The Subscriptions enables you to create, view, update, and delete individual, or a batch of subscriptions. This table will show data only if WooCommerce Subscriptions Plugin is enabled.
SubscriptionShippingLines	Retrieve all subscription shipping lines. This view will show data only if WooCommerce Subscriptions Plugin is enabled.
SystemStatus	Retrieve system status items.
SystemStatusPages	Retrieve and system status items.
SystemStatusTools	Retrieve system status tools.
TaxClasses	Retrieve and modify tax classes.
TaxRates	Retrieve and modify tax rates.
TopSellersReports	Execute a top sellers report.
TotalsReport	Execute a totals report.
Webhooks	Retrieve and modify webhooks.

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	Attribute ID.
Name	String	False	No	Attribute name.
Slug	String	False	No	An alphanumeric identifier for the resource unique to its type.
Type	String	False	No	Type of attribute. By default only select is supported.
OrderBy	String	False	No	Default sort order. Options: menu_order, name, name_num and id. Defaults to menu_order.
HasArchives	Boolean	False	No	Enable/Disable attribute archives. Defaults to false.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Unique identifier for the resource.
Name	String	False	No	Category name.
Slug	String	False	No	An alphanumeric identifier for the resource unique to its type.
Parent	Long	False	No	The ID for the parent of the resource.
Description	String	False	No	HTML description of the resource.
Display	String	False	No	Category archive display type. Options: default, products, subcategories and both.
MenuOrder	Integer	False	No	Menu order, used to custom sort the resource.
Count	Integer	True	No	Number of published products for the resource.
ImageId	Long	False	No	Image ID.
ImageDateCreated	Datetime	True	No	The date the image was created, in the site's timezone.
ImageDateModified	Datetime	True	No	The date the image was last modified, in the site's timezone.
ImageSrc	String	False	No	Image URL.
ImageName	String	False	No	Image name.
ImageAlt	String	False	No	Image alternative text.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Code	String	True	No	2 character continent code.
Name	String	True	No	Full name of continent.
CountriesAggregate	String	True	No	List of countries on this continent. See Continents - Countries properties read-only

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Code	String	True	No	ISO3166 alpha-2 country code.
Name	String	True	No	Full name of country.
StatesAggregate	String	True	No	List of states in this country. See Countries - States properties read-only

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Unique identifier for the object.
Code	String	False	No	Coupon code.
Amount	String	False	No	The amount of discount. Should always be numeric, even if setting a percentage.
DateCreated	Datetime	True	No	The date the coupon was created, in the site's timezone.
DateModified	Datetime	True	No	The date the coupon was last modified, in the site's timezone.
DiscountType	String	False	No	Determines the type of discount that will be applied. Options: percent, fixed_cart and fixed_product. Defaults to fixed_cart.
Description	String	False	No	Coupon description.
DateExpires	Datetime	False	No	The date the coupon expires, in the site's timezone.
UsageCount	Integer	True	No	Number of times the coupon has been used already.
IndividualUse	Boolean	False	No	If true, the coupon can only be used individually. Other applied coupons will be removed from the cart. Defaults to false.
ProductIdsAggregate	String	False	No	List of product IDs the coupon can be used on.
ExcludedProductIdsAggregate	String	False	No	List of product IDs the coupon cannot be used on.
UsageLimit	Integer	False	No	How many times the coupon can be used in total.
UsageLimitPerUser	Integer	False	No	How many times the coupon can be used per customer.
LimitUsageToXItems	Integer	False	No	Max number of items in the cart the coupon can be applied to.
FreeShipping	Boolean	False	No	If true and if the free shipping method requires a coupon, this coupon will enable free shipping. Defaults to false.
ProductCategoriesAggregate	String	False	No	List of category IDs the coupon applies to.
ExcludedProductCategoriesAggregate	String	False	No	List of category IDs the coupon does not apply to.
ExcludeSaleItems	Boolean	False	No	If true, this coupon will not be applied to items that have sale prices. Defaults to false.
MinimumAmount	String	False	No	Minimum order amount that needs to be in the cart before coupon applies.
MaximumAmount	String	False	No	Maximum order amount allowed when using the coupon.
EmailRestrictionsAggregate	String	False	No	List of email addresses that can use this coupon.
UsedByAggregate	String	True	No	List of user IDs (or guest email addresses) that have used the coupon.
Metadata	String	True	No	Meta data. See Coupon - Meta data properties.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Code	String	True	No	ISO4217 currency code.
Name	String	True	No	Full name of currency.
Symbol	String	True	No	Currency symbol.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	Metadata ID.
Key	String	False		No	Metadata key.
Value	String	False		No	Metadata value.
CustomerId	String	False	Customers.Id	No	Id of the customer.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Unique identifier for the resource.
DateCreated	Datetime	True	No	The date the customer was created, in the site's timezone.
DateModified	Datetime	True	No	The date the customer was last modified, in the site's timezone.
Email	String	False	No	The email address for the customer.
FirstName	String	False	No	Customer first name.
LastName	String	False	No	Customer last name.
Role	String	True	No	Customer role.
Username	String	False	No	Customer login name.
Password	String	False	No	Customer password. write-only
IsPayingCustomer	Bool	True	No	Is the customer a paying customer? read-only
AvatarUrl	String	True	No	Avatar URL.
MetaDataAggregate	String	False	No	Meta data.
BillingFirstName	String	False	No	First name.
BillingLastName	String	False	No	Last name.
BillingCompany	String	False	No	Company name.
BillingAddress1	String	False	No	Address line 1
BillingAddress2	String	False	No	Address line 2
BillingCity	String	False	No	City name.
BillingState	String	False	No	ISO code or name of the state, province or district.
BillingPostcode	String	False	No	Postal code.
BillingCountry	String	False	No	ISO code of the country.
BillingEmail	String	False	No	Email address.
BillingPhone	String	False	No	Phone number.
ShippingFirstName	String	False	No	First name.
ShippingLastName	String	False	No	Last name.
ShippingCompany	String	False	No	Company name.
ShippingAddress1	String	False	No	Address line 1
ShippingAddress2	String	False	No	Address line 2
ShippingCity	String	False	No	City name.
ShippingState	String	False	No	ISO code or name of the state, province or district.
ShippingPostcode	String	False	No	Postal code.
ShippingCountry	String	False	No	ISO code of the country.
ReferenceNumber	String	False	Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Item ID.
Code	String	False		No	Coupon code.
Discount	String	True		No	Discount total.
DiscountTax	String	True		No	Discount total tax.
MetaData	String	False		No	Meta data. See Order - Meta data properties
OrderId [KEY]	String	True	Orders.Id	No	Id of the order.
ReferenceNumber	String	False		Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Item ID.
Name	String	False		No	Fee name.
TaxClass	String	False		No	Tax class of fee.
TaxStatus	String	False		No	Tax status of fee. Options: taxable and none.
Total	String	False		No	Line total (after discounts).
TotalTax	String	True		No	Line total tax (after discounts).
Taxes	String	True		No	Line taxes. See Order - Taxes properties read-only
MetaData	String	False		No	Meta data. See Order - Meta data properties
OrderId [KEY]	String	True	Orders.Id	No	Id of the order.
ReferenceNumber	String	False		Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Item ID.
Name	String	False		No	Product name.
ProductId	Long	False		No	Product ID.
VariationId	Long	False		No	Variation ID, if applicable.
Quantity	Integer	False		No	Quantity ordered.
TaxClass	String	False		No	Tax class of product.
Subtotal	String	False		No	Line subtotal (before discounts).
SubtotalTax	String	True		No	Line subtotal tax (before discounts).
Total	String	False		No	Line total (after discounts).
TotalTax	String	True		No	Line total tax (after discounts).
Taxes	String	True		No	Line taxes. See Order - Taxes properties read-only
MetaData	String	False		No	Meta data. See Order - Meta data properties
Sku	String	True		No	Product SKU.
Price	String	True		No	Product price.
OrderId [KEY]	String	True	Orders.Id	No	Id of the order.
ReferenceNumber	String	False		Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Unique identifier for the resource.
Author	String	True		No	Order note author.
DateCreated	Datetime	True		No	The date the order note was created, in the site's timezone.
Note	String	False		No	Order note content.
CustomerNote	Boolean	False		No	If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only. Defaults to false.
AddedByUser	Boolean	False		No	If true, this note will be attributed to the current user. If false, the note will be attributed to the system. Defaults to false.
OrderId [KEY]	String	False	Orders.Id	No	Id of the order.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id	Long	False		No	Item ID.
Name	String	False		No	Product name.
ProductId	Long	False		No	Product ID.
VariationId	Long	False		No	Variation ID, if applicable.
Quantity	Integer	False		No	Quantity ordered.
TaxClass	Integer	False		No	Tax class of product.
Subtotal	String	False		No	Line subtotal (before discounts).
SubtotalTax	String	True		No	Line subtotal tax (before discounts).
Total	String	False		No	Line total (after discounts).
TotalTax	String	True		No	Line total tax (after discounts).
TaxesAggregate	String	True		No	Line taxes. See Order refund line item - Taxes properties read-only
MetaDataAggregate	String	False		No	Meta data. See Order refund - Meta data properties
Sku	String	True		No	Product SKU.
Price	String	True		No	Product price.
OrderId	String	True	Orders.Id	No	Id of the order.
RefundId	String	True	OrderRefunds.Id	No	Id of the refund.
ReferenceNumber	String	False		Yes	This column will be used in Bulk operations to get specific values from the Temp tables.
RefundTotal	String	False		Yes	The amount to refund for this line item, excluding taxes.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Unique identifier for the resource.
DateCreated	Datetime	True		No	The date the order refund was created, in the site's timezone.
Amount	String	False		No	Refund amount.
Reason	String	False		No	Reason for refund.
RefundedBy	Long	False		No	User ID of user who created the refund.
RefundedPayment	Boolean	True		No	If the payment was refunded via the API. See api_refund.
LineItems	String	False		No	Line items data. See Order refund - Line items properties
ApiRefund	Boolean	False		No	When true, the payment gateway API is used to generate the refund. Defaults to true. write-only
Metadata	String	True		No	Meta data. See OrderRefunds - Meta data properties.
OrderId [KEY]	String	True	Orders.Id	No	Id of the order.
ReferenceNumber	String	False		Yes	This column will be used in Bulk operations to get specific values from the Temp tables.
ApiRestock	Boolean	False		Yes	When true, the selected line items are restocked. Default is true.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Unique identifier for the resource.
ParentId	Long	False	No	Parent order ID.
Number	String	True	No	Order number.
OrderKey	String	True	No	Order key.
CreatedVia	String	True	No	Shows where the order was created.
Version	String	True	No	Version of WooCommerce which last updated the order.
Status	String	False	No	Order status. Options: pending, processing, on-hold, completed, cancelled, refunded, failed and trash. Defaults to pending.
Currency	String	False	No	Currency the order was created with, in ISO format. Options: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTC, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, IRT, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PRB, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR and ZMW. Defaults to USD.
DateCreated	Datetime	True	No	The date the order was created, in the site's timezone.
DateModified	Datetime	True	No	The date the order was last modified, in the site's timezone.
DiscountTotal	String	True	No	Total discount amount for the order.
DiscountTax	String	True	No	Total discount tax amount for the order.
ShippingTotal	String	True	No	Total shipping amount for the order.
ShippingTax	String	True	No	Total shipping tax amount for the order.
CartTax	String	True	No	Sum of line item taxes only.
Total	String	True	No	Grand total.
TotalTax	String	True	No	Sum of all taxes.
PricesIncludeTax	Boolean	True	No	True the prices included tax during checkout.
CustomerId	Long	False	No	User ID who owns the order. 0 for guests. Defaults to 0.
CustomerIpAddress	String	True	No	Customer's IP address.
CustomerUserAgent	String	True	No	User agent of the customer.
CustomerNote	String	False	No	Note left by customer during checkout.
PaymentMethod	String	False	No	Payment method ID.
PaymentMethodTitle	String	False	No	Payment method title.
TransactionId	String	False	No	Unique transaction ID.
DatePaid	Datetime	True	No	The date the order was paid, in the site's timezone.
DateCompleted	Datetime	True	No	The date the order was completed, in the site's timezone.
CartHash	String	True	No	MD5 hash of cart items to ensure orders are not modified.
LineItemsAggregate	String	False	No	Line items data. See Order - Line items properties
TaxLinesAggregate	String	True	No	Tax lines data.
ShippingLinesAggregate	String	False	No	Shipping lines data.
FeeLinesAggregate	String	False	No	Fee lines data.
CouponLinesAggregate	String	False	No	Coupons line data.
RefundsAggregate	String	True	No	List of refunds.
SetPaid	Boolean	False	No	Define if the order is paid. It will set the status to processing and reduce stock items. Defaults to false. write-only
BillingFirstName	String	False	No	First name.
BillingLastName	String	False	No	Last name.
BillingCompany	String	False	No	Company name.
BillingAddress1	String	False	No	Address line 1
BillingAddress2	String	False	No	Address line 2
BillingCity	String	False	No	City name.
BillingState	String	False	No	ISO code or name of the state, province or district.
BillingPostcode	String	False	No	Postal code.
BillingCountry	String	False	No	Country code in ISO 3166-1 alpha-2 format.
BillingEmail	String	False	No	Email address.
BillingPhone	String	False	No	Phone number.
ShippingFirstName	String	False	No	First name.
ShippingLastName	String	False	No	Last name.
ShippingCompany	String	False	No	Company name.
ShippingAddress1	String	False	No	Address line 1
ShippingAddress2	String	False	No	Address line 2
ShippingCity	String	False	No	City name.
ShippingState	String	False	No	ISO code or name of the state, province or district.
ShippingPostcode	String	False	No	Postal code.
ShippingCountry	String	False	No	Country code in ISO 3166-1 alpha-2 format.
Metadata	String	False	No	Meta data. See Order - Meta data properties.
ProductId	Long	False	No	Limit result set to resources assigned to a specific product.
ReferenceNumber	String	False	Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Item ID.
MethodTitle	String	False		No	Shipping method name.
MethodId	String	False		No	Shipping method ID.
Total	String	False		No	Line total (after discounts).
TotalTax	String	True		No	Line total tax (after discounts).
Taxes	String	True		No	Line taxes. See Order - Taxes properties read-only
MetaData	String	False		No	Meta data. See Order - Meta data properties
OrderId [KEY]	Long	True	Orders.Id	No	Id of the order.
ReferenceNumber	String	False		Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Item ID.
RateCode	String	True		No	Tax rate code.
RateId	String	True		No	Tax rate ID.
Label	String	True		No	Tax rate label.
Compound	Boolean	True		No	Show if is a compound tax rate.
TaxTotal	String	True		No	Tax total (not including shipping taxes).
ShippingTaxTotal	String	True		No	Shipping tax total.
MetaData	String	False		No	Meta data. See Order - Meta data properties
OrderId [KEY]	Long	True	Orders.Id	No	Id of the order.
ReferenceNumber	String	False		Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	Payment gateway ID.
Title	String	False	No	Payment gateway title on checkout.
Description	String	False	No	Payment gateway description on checkout.
Order	Integer	False	No	Payment gateway sort order.
Enabled	Boolean	False	No	Payment gateway enabled status.
MethodTitle	String	True	No	Payment gateway method title.
MethodDescription	String	True	No	Payment gateway method description.
MethodSupportsAggregate	String	True	No	Supported features for this payment gateway.
SettingsTitleId	String	True	No	A unique identifier for the setting.
SettingsTitleDefault	String	True	No	Default value for the setting.
SettingsTitleDescription	String	True	No	A human readable description for the setting used in interfaces.
SettingsTitleLabel	String	True	No	A human readable label for the setting used in interfaces.
SettingsTitlePlaceholder	String	True	No	Placeholder text to be displayed in text inputs.
SettingsTitleTip	String	True	No	Additional help text shown to the user about the setting.
SettingsTitleType	String	True	No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsTitleValue	String	True	No	Setting value.
SettingsInstructionsId	String	True	No	Id value for the setting.
SettingsInstructionsDefault	String	True	No	Default value for the setting.
SettingsInstructionsDescription	String	True	No	A human readable description for the setting used in interfaces.
SettingsInstructionsLabel	String	True	No	A human readable label for the setting used in interfaces.
SettingsInstructionsPlaceholder	String	True	No	Placeholder text to be displayed in text inputs.
SettingsInstructionsTip	String	True	No	Additional help text shown to the user about the setting.
SettingsInstructionsType	String	True	No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsInstructionsValue	String	True	No	Setting value.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Attribute ID.
Name	String	False		No	Attribute name.
Slug	String	False		No	An alphanumeric identifier for the resource unique to its type.
Type	String	False		No	Type of attribute. By default only select is supported.
OrderBy	String	False		No	Default sort order. Options: menu_order, name, name_num and id. Defaults to menu_order.
HasArchives	Boolean	False		No	Enable/Disable attribute archives. Defaults to false.
ProductId [KEY]	Long	True	Products.Id	No	Id of the product.
ReferenceNumber	String	False		Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Unique identifier for the resource.
Name	String	False		No	Term name.
Slug	String	False		No	An alphanumeric identifier for the resource unique to its type.
Description	String	False		No	HTML description of the resource.
MenuOrder	Integer	False		No	Menu order, used to custom sort the resource.
Count	Integer	True		No	Number of published products for the resource.
AttributeId [KEY]	Long	False	ProductAttributes.Id	No	Id of the attribute.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Unique identifier for the resource.
Name	String	False		No	Category name.
Slug	String	False		No	An alphanumeric identifier for the resource unique to its type.
ProductId [KEY]	Long	True	Products.Id	No	Id of the product.
ReferenceNumber	String	False		Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Image ID.
DateCreated	Datetime	True		No	The date the image was created, in the site's timezone.
DateModified	Datetime	True		No	The date the image was last modified, in the site's timezone.
Src	String	False		No	Image URL.
Name	String	False		No	Image name.
Alt	String	False		No	Image alternative text.
ProductId [KEY]	Long	True	Products.Id	No	Id of the product.
ReferenceNumber	String	False		Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Unique identifier for the resource.
DateCreated	Datetime	True	No	The date the review was created, in the site's timezone.
ProductId	Long	False	No	Unique identifier for the product that the review belongs to.
Status	String	False	No	Status of the review. Options: approved, hold, spam, unspam, trash and untrash. Defauls to approved.
Reviewer	String	False	No	Reviewer name.
ReviewerEmail	String	False	No	Reviewer email.
Review	String	False	No	The content of the review.
Rating	Integer	False	No	Review rating (0 to 5).
Verified	Boolean	False	No	Shows if the reviewer bought the product or not.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Unique identifier for the resource.
Name	String	False	No	Product name.
Slug	String	False	No	Product slug.
Permalink	String	True	No	Product URL.
DateCreated	Datetime	True	No	The date the product was created, in the site's timezone.
DateModified	Datetime	True	No	The date the product was last modified, in the site's timezone.
Type	String	False	No	Product type. Options: simple, grouped, external and variable. Defaults to simple.
Status	String	False	No	Product status (post status). Options: draft, pending, private and publish. Defaults to publish.
Featured	Boolean	False	No	Featured product. Defaults to false.
CatalogVisibility	String	False	No	Catalog visibility. Options: visible, catalog, search and hidden. Defaults to visible.
Description	String	False	No	Product description.
ShortDescription	String	False	No	Product short description.
Sku	String	False	No	Unique identifier.
Price	String	True	No	Current product price.
RegularPrice	String	False	No	Product regular price.
SalePrice	String	False	No	Product sale price.
DateOnSaleFrom	Datetime	False	No	Start date of sale price, in the site's timezone.
DateOnSaleTo	Datetime	False	No	End date of sale price, in the site's timezone.
PriceHtml	String	True	No	Price formatted in HTML.
OnSale	Boolean	True	No	Shows if the product is on sale.
Purchasable	Boolean	True	No	Shows if the product can be bought.
TotalSales	Integer	True	No	Amount of sales.
Virtual	Boolean	False	No	If the product is virtual. Defaults to false.
Downloadable	Boolean	False	No	If the product is downloadable. Defaults to false.
Downloads	String	False	No	List of downloadable files.
DownloadLimit	Integer	False	No	Number of times downloadable files can be downloaded after purchase. Defaults to -1.
DownloadExpiry	Integer	False	No	Number of days until access to downloadable files expires. Defaults to -1.
ExternalUrl	String	False	No	Product external URL. Only for external products.
ButtonText	String	False	No	Product external button text. Only for external products.
TaxStatus	String	False	No	Tax status. Options: taxable, shipping and none. Defaults to taxable.
TaxClass	String	False	No	Tax class.
ManageStock	Boolean	False	No	Stock management at product level. Defaults to false.
StockQuantity	Integer	False	No	Stock quantity.
StockStatus	String	False	No	Controls the stock status of the product. Options: instock, outofstock, onbackorder. Defaults to instock.
Backorders	String	False	No	If managing stock, this controls if backorders are allowed. Options: no, notify and yes. Defaults to no.
BackordersAllowed	Boolean	True	No	Shows if backorders are allowed.
Backordered	Boolean	True	No	Shows if the product is on backordered.
SoldIndividually	Boolean	False	No	Allow one item to be bought in a single order. Defaults to false.
Weight	String	False	No	Product weight.
ShippingRequired	Boolean	True	No	Shows if the product need to be shipped.
ShippingTaxable	Boolean	True	No	Shows whether or not the product shipping is taxable.
ShippingClass	String	False	No	Shipping class slug.
ShippingClassId	Long	True	No	Shipping class ID.
ReviewsAllowed	Boolean	False	No	Allow reviews. Defaults to true.
AverageRating	String	True	No	Reviews average rating.
RatingCount	Integer	True	No	Amount of reviews that the product have.
RelatedIdsAggregate	String	True	No	List of related products IDs.
UpsellIdsAggregate	String	False	No	List of up-sell products IDs.
CrossSellIdsAggregate	String	False	No	List of cross-sell products IDs.
ParentId	Long	False	No	Product parent ID.
PurchaseNote	String	False	No	Optional note to send the customer after purchase.
CategoriesAggregate	String	False	No	List of categories.
TagsAggregate	String	False	No	List of tags.
ImagesAggregate	String	False	No	List of images.
AttributesAggregate	String	False	No	List of attributes.
DefaultAttributesAggregate	String	False	No	Defaults variation attributes.
VariationsAggregate	String	True	No	List of variations IDs.
GroupedProductsAggregate	String	False	No	List of grouped products ID.
MenuOrder	Integer	False	No	Menu order, used to custom sort products.
MetaData	String	False	No	Meta data.
DimensionsLength	String	False	No	Product length.
DimensionsWidth	String	False	No	Product width.
DimensionsHeight	String	False	No	Product height.
ReferenceNumber	String	False	Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Unique identifier for the resource.
Name	String	False	No	Shipping class name.
Slug	String	False	No	An alphanumeric identifier for the resource unique to its type.
Description	String	False	No	HTML description of the resource.
Count	Integer	True	No	Number of published products for the resource.
ProductId	Long	False	No	Limit result set to resources assigned to a specific product.
ReferenceNumber	String	False	Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Unique identifier for the resource.
Name	String	False	No	Tag name.
Slug	String	False	No	An alphanumeric identifier for the resource unique to its type.
Description	String	False	No	HTML description of the resource.
Count	Integer	True	No	Number of published products for the resource.
ProductId	Long	False	No	Limit result set to resources assigned to a specific product.
ReferenceNumber	String	False	Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Unique identifier for the resource.
DateCreated	Datetime	True		No	The date the variation was created, in the site's timezone.
DateModified	Datetime	True		No	The date the variation was last modified, in the site's timezone.
Description	String	False		No	Variation description.
Permalink	String	True		No	Variation URL.
Sku	String	False		No	Unique identifier.
Price	String	True		No	Current variation price.
RegularPrice	String	False		No	Variation regular price.
SalePrice	String	False		No	Variation sale price.
DateOnSaleFrom	Datetime	False		No	Start date of sale price, in the site's timezone.
DateOnSaleTo	Datetime	False		No	End date of sale price, in the site's timezone.
OnSale	Boolean	True		No	Shows if the variation is on sale.
Status	String	False		No	Variation status. Options: draft, pending, private and publish. Defaults to publish.
Purchasable	Boolean	True		No	Shows if the variation can be bought.
Virtual	Boolean	False		No	If the variation is virtual. Defaults to false.
Downloadable	Boolean	False		No	If the variation is downloadable. Defaults to false.
DownloadsAggregate	String	False		No	List of downloadable files. See Product variation - Downloads properties
DownloadLimit	Integer	False		No	Number of times downloadable files can be downloaded after purchase. Defaults to -1.
DownloadExpiry	Integer	False		No	Number of days until access to downloadable files expires. Defaults to -1.
TaxStatus	String	False		No	Tax status. Options: taxable, shipping and none. Defaults to taxable.
TaxClass	String	False		No	Tax class.
ManageStock	String	False		No	Stock management at variation level. Defaults to false. If the stock is managed by product and not variaation then the value is parent.
StockQuantity	Integer	False		No	Stock quantity.
StockStatus	String	False		No	Controls the stock status of the product. Options: instock, outofstock, onbackorder. Defaults to instock.
Backorders	String	False		No	If managing stock, this controls if backorders are allowed. Options: no, notify and yes. Defaults to no.
BackordersAllowed	Boolean	True		No	Shows if backorders are allowed.
Backordered	Boolean	True		No	Shows if the variation is on backordered.
Weight	String	False		No	Variation weight.
ShippingClass	String	False		No	Shipping class slug.
ShippingClassId	String	True		No	Shipping class ID.
AttributesAggregate	String	False		No	List of attributes. See Product variation - Attributes properties
MenuOrder	Integer	False		No	Menu order, used to custom sort products.
MetaData	String	False		No	Meta data. See Product variation - Meta data properties
DimensionsLength	String	False		No	Variation length.
DimensionsWidth	String	False		No	Variation width.
DimensionsHeight	String	False		No	Variation height.
ImageId	Long	False		No	Image ID.
ImageDateCreated	Datetime	True		No	The date the image was created, in the site's timezone.
ImageDateModified	Datetime	True		No	The date the image was last modified, in the site's timezone.
ImageSrc	String	False		No	Image URL.
ImageName	String	False		No	Image name.
ImageAlt	String	False		No	Image alternative text.
ProductId [KEY]	Long	False	Products.Id	No	Id of the product.
ParentId	Long	False		No	The id of the parent, filtered server side.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
TotalSales	String	True	No	Gross sales in the period.
NetSales	String	True	No	Net sales in the period.
AverageSales	String	True	No	Average net daily sales.
TotalOrders	Integer	True	No	Total of orders placed.
TotalItems	Integer	True	No	Total of items purchased.
TotalTax	String	True	No	Total charged for taxes.
TotalShipping	String	True	No	Total charged for shipping.
TotalRefunds	Integer	True	No	Total of refunded orders.
TotalDiscount	Integer	True	No	Total of coupons used.
TotalsGroupedBy	String	True	No	Group type.
TotalsAggregate	String	True	No	Totals.
Period	String	False	No	Report period. Defaults to week. Options: week, month, last_month and year.
StartDate	Date	False	No	Return sales for a specific start date, the date need to be in the YYYY-MM-DD format.
EndDate	Date	False	No	Return sales for a specific end date, the date need to be in the YYYY-MM-DD format.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A unique identifier that can be used to link settings together.
Label	String	True	No	A human readable label for the setting used in interfaces.
Description	String	True	No	A human readable description for the setting used in interfaces.
ParentId	String	True	No	ID of parent grouping.
SubGroups	String	True	No	ID for settings sub groups.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	A unique identifier for the setting.
SettingId [KEY]	String	False	SettingGroups.Id	No	Id of the setting group.
Label	String	True		No	A human readable label for the setting used in interfaces.
Description	String	True		No	A human readable description for the setting used in interfaces.
Value	String	False		No	Setting value.
Default	String	True		No	Default value for the setting.
Tip	String	True		No	Additional help text shown to the user about the setting.
Placeholder	String	True		No	Placeholder text to be displayed in text inputs.
Type	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
GroupId	String	True		No	An identifier for the group this setting belongs to.
Options	String	True		No	Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Code	String	False		No	Shipping zone location code.
Type	String	False		No	Shipping zone location type. Options: postcode, state, country and continent. Defaults to country.
ZoneId	Long	True	ShippingZones.Id	No	Id of the shipping zone.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	Method ID.
Title	String	True	No	Shipping method title.
Description	String	True	No	Shipping method description.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
InstanceId [KEY]	Long	False		No	Shipping method instance ID.
Enabled	Boolean	False		No	Shipping method enabled status.
MethodDescription	String	False		No	hipping method description.
MethodId	String	False		No	Shipping method ID.
MethodTitle	String	False		No	Shipping method title.
Order	Integer	False		No	Shipping method sort order.
Title	String	False		No	Shipping method customer facing title.
SettingsTitleId	String	True		No	A unique identifier for the setting.
SettingsTitleLabel	String	True		No	A human readable label for the setting used in interfaces.
SettingsTitleDescription	String	True		No	A human readable description for the setting used in interfaces.
SettingsTitleType	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsTitleValue	String	False		No	Setting value.
SettingsTitleDefault	String	True		No	Default value for the setting.
SettingsTitleTip	String	True		No	Additional help text shown to the user about the setting.
SettingsTitlePlaceholder	String	True		No	Placeholder text to be displayed in text inputs.
SettingsTaxStatusId	String	True		No	A unique identifier for the setting.
SettingsTaxStatusLabel	String	True		No	A human readable label for the setting used in interfaces.
SettingsTaxStatusDescription	String	True		No	A human readable description for the setting used in interfaces.
SettingsTaxStatusType	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsTaxStatusValue	String	False		No	Setting value.
SettingsTaxStatusDefault	String	True		No	Default value for the setting.
SettingsTaxStatusTip	String	True		No	Additional help text shown to the user about the setting.
SettingsTaxStatusPlaceholder	String	True		No	Placeholder text to be displayed in text inputs.
SettingsTaxStatusOptions	String	True		No	Options under Tax Status.
SettingsCostId	String	True		No	A unique identifier for the setting.
SettingsCostLabel	String	True		No	A human readable label for the setting used in interfaces.
SettingsCostDescription	String	True		No	A human readable description for the setting used in interfaces.
SettingsCostType	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsCostValue	String	False		No	Setting value.
SettingsCostDefault	String	True		No	Default value for the setting.
SettingsCostTip	String	True		No	Additional help text shown to the user about the setting.
SettingsCostPlaceholder	String	True		No	Placeholder text to be displayed in text inputs.
SettingsTypeId	String	True		No	A unique identifier for the setting.
SettingsTypeLabel	String	True		No	A human readable label for the setting used in interfaces.
SettingsTypeDescription	String	True		No	A human readable description for the setting used in interfaces.
SettingsTypeType	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsTypeValue	String	False		No	Setting value.
SettingsTypeDefault	String	True		No	Default value for the setting.
SettingsTypeTip	String	True		No	Additional help text shown to the user about the setting.
SettingsTypePlaceholder	String	True		No	Placeholder text to be displayed in text inputs.
SettingsTypeOptions	String	True		No	Setting Type Options.
SettingsClassCostsId	String	True		No	A unique identifier for the setting.
SettingsClassCostsLabel	String	True		No	A human readable label for the setting used in interfaces.
SettingsClassCostsDescription	String	True		No	A human readable description for the setting used in interfaces.
SettingsClassCostsType	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsClassCostsDefault	String	True		No	Default value for the setting.
SettingsClassCostsPlaceholder	String	True		No	Placeholder text to be displayed in text inputs.
SettingsClassCostsTip	String	True		No	Additional help text shown to the user about the setting.
SettingsClassCostsValue	String	True		No	Setting value.
SettingsClassCostId29	String	True		No	A unique identifier for the setting.
SettingsClassCostLabel29	String	True		No	A human readable label for the setting used in interfaces.
SettingsClassCostDescription29	String	True		No	A human readable description for the setting used in interfaces.
SettingsClassCostType29	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsClassCostDefault29	String	True		No	Default value for the setting.
SettingsClassCostPlaceholder29	String	True		No	Placeholder text to be displayed in text inputs.
SettingsClassCostTip29	String	True		No	Additional help text shown to the user about the setting.
SettingsClassCostValue29	String	True		No	Setting value.
SettingsClassCostId30	String	True		No	A unique identifier for the setting.
SettingsClassCostLabel30	String	True		No	A human readable label for the setting used in interfaces.
SettingsClassCostDescription30	String	True		No	A human readable description for the setting used in interfaces.
SettingsClassCostType30	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsClassCostDefault30	String	True		No	Default value for the setting.
SettingsClassCostPlaceholder30	String	True		No	Placeholder text to be displayed in text inputs.
SettingsClassCostTip30	String	True		No	Additional help text shown to the user about the setting.
SettingsClassCostValue30	String	True		No	Setting value.
SettingsClassCostId31	String	True		No	A unique identifier for the setting.
SettingsClassCostLabel31	String	True		No	A human readable label for the setting used in interfaces.
SettingsClassCostDescription31	String	True		No	A human readable description for the setting used in interfaces.
SettingsClassCostType31	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsClassCostDefault31	String	True		No	Default value for the setting.
SettingsClassCostPlaceholder31	String	True		No	Placeholder text to be displayed in text inputs.
SettingsClassCostTip31	String	True		No	Additional help text shown to the user about the setting.
SettingsClassCostValue31	String	True		No	Setting value.
SettingsClassCostId32	String	True		No	A unique identifier for the setting.
SettingsClassCostLabel32	String	True		No	A human readable label for the setting used in interfaces.
SettingsClassCostDescription32	String	True		No	A human readable description for the setting used in interfaces.
SettingsClassCostType32	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsClassCostDefault32	String	True		No	Default value for the setting.
SettingsClassCostPlaceholder32	String	True		No	Placeholder text to be displayed in text inputs.
SettingsClassCostTip32	String	True		No	Additional help text shown to the user about the setting.
SettingsClassCostValue32	String	True		No	Setting value.
SettingsClassCostId33	String	True		No	A unique identifier for the setting.
SettingsClassCostLabel33	String	True		No	A human readable label for the setting used in interfaces.
SettingsClassCostDescription33	String	True		No	A human readable description for the setting used in interfaces.
SettingsClassCostType33	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsClassCostDefault33	String	True		No	Default value for the setting.
SettingsClassCostPlaceholder33	String	True		No	Placeholder text to be displayed in text inputs.
SettingsClassCostTip33	String	True		No	Additional help text shown to the user about the setting.
SettingsClassCostValue33	String	True		No	Setting value.
SettingsClassCostId34	String	True		No	A unique identifier for the setting.
SettingsClassCostLabel34	String	True		No	A human readable label for the setting used in interfaces.
SettingsClassCostDescription34	String	True		No	A human readable description for the setting used in interfaces.
SettingsClassCostType34	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsClassCostDefault34	String	True		No	Default value for the setting.
SettingsClassCostPlaceholder34	String	True		No	Placeholder text to be displayed in text inputs.
SettingsClassCostTip34	String	True		No	Additional help text shown to the user about the setting.
SettingsClassCostValue34	String	True		No	Setting value.
SettingsClassCostId54	String	True		No	A unique identifier for the setting.
SettingsClassCostLabel54	String	True		No	A human readable label for the setting used in interfaces.
SettingsClassCostDescription54	String	True		No	A human readable description for the setting used in interfaces.
SettingsClassCostType54	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsClassCostDefault54	String	True		No	Default value for the setting.
SettingsClassCostPlaceholder54	String	True		No	Placeholder text to be displayed in text inputs.
SettingsClassCostTip54	String	True		No	Additional help text shown to the user about the setting.
SettingsClassCostValue54	String	True		No	Setting value.
SettingsClassCostId55	String	True		No	A unique identifier for the setting.
SettingsClassCostLabel55	String	True		No	A human readable label for the setting used in interfaces.
SettingsClassCostDescription55	String	True		No	A human readable description for the setting used in interfaces.
SettingsClassCostType55	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsClassCostDefault55	String	True		No	Default value for the setting.
SettingsClassCostPlaceholder55	String	True		No	Placeholder text to be displayed in text inputs.
SettingsClassCostTip55	String	True		No	Additional help text shown to the user about the setting.
SettingsClassCostValue55	String	True		No	Setting value.
SettingsClassCostId56	String	True		No	A unique identifier for the setting.
SettingsClassCostLabel56	String	True		No	A human readable label for the setting used in interfaces.
SettingsClassCostDescription56	String	True		No	A human readable description for the setting used in interfaces.
SettingsClassCostType56	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsClassCostDefault56	String	True		No	Default value for the setting.
SettingsClassCostPlaceholder56	String	True		No	Placeholder text to be displayed in text inputs.
SettingsClassCostTip56	String	True		No	Additional help text shown to the user about the setting.
SettingsClassCostValue56	String	True		No	Setting value.
SettingsClassCostId57	String	True		No	A unique identifier for the setting.
SettingsClassCostLabel57	String	True		No	A human readable label for the setting used in interfaces.
SettingsClassCostDescription57	String	True		No	A human readable description for the setting used in interfaces.
SettingsClassCostType57	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsClassCostDefault57	String	True		No	Default value for the setting.
SettingsClassCostPlaceholder57	String	True		No	Placeholder text to be displayed in text inputs.
SettingsClassCostTip57	String	True		No	Additional help text shown to the user about the setting.
SettingsClassCostValue57	String	True		No	Setting value.
SettingsClassCostId58	String	True		No	A unique identifier for the setting.
SettingsClassCostLabel58	String	True		No	A human readable label for the setting used in interfaces.
SettingsClassCostDescription58	String	True		No	A human readable description for the setting used in interfaces.
SettingsClassCostType58	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsClassCostDefault58	String	True		No	Default value for the setting.
SettingsClassCostPlaceholder58	String	True		No	Placeholder text to be displayed in text inputs.
SettingsClassCostTip58	String	True		No	Additional help text shown to the user about the setting.
SettingsClassCostValue58	String	True		No	Setting value.
SettingsNoCostId	String	True		No	A unique identifier for the setting.
SettingsNoCostLabel	String	True		No	A human readable label for the setting used in interfaces.
SettingsNoCostDescription	String	True		No	A human readable description for the setting used in interfaces.
SettingsNoCostType	String	True		No	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsNoCostDefault	String	True		No	Default value for the setting.
SettingsNoCostPlaceholder	String	True		No	Placeholder text to be displayed in text inputs.
SettingsNoCostTip	String	True		No	Additional help text shown to the user about the setting.
SettingsNoCostValue	String	True		No	Setting value.
ZoneId [KEY]	Long	False	ShippingZones.Id	No	Id of the shipping zone.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Unique identifier for the resource.
Name	String	False	No	Shipping zone name.
Order	Integer	False	No	Shipping zone order.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Country	String	True	No	State code.
Code	String	True	No	State code.
Name	String	True	No	Full name of the state.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	Item ID.
SubscriptionId	Integer	False	Subscriptions.Id	No	Subscription ID.
Code	String	False		No	Coupon code.
MetaData	String	False		No	Meta data.
Discount	String	False		No	Discount total.
DiscountTax	String	True		No	Discount total tax.
ParentId	Integer	True		No	Parent/initial order ID for the subscription.
CustomerId	Integer	True	Customers.Id	No	User ID who owns the subscription.
Status	String	True		No	Subscription status.
Product	String	False		Yes	Limit result set to subscriptions assigned a specific product ID.
ReferenceNumber	String	False		Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id	Integer	True		No	Item ID.
SubscriptionId	Integer	False	Subscriptions.Id	No	Subscription ID.
Amount	String	False		No	Fee amount.
MetaData	String	False		No	Meta data.
Name	String	False		No	Fee name.
TaxClass	String	False		No	Tax class.
TaxStatus	String	False		No	Tax status of fee. Set to taxable if need apply taxes.
Taxes	String	True		No	Line taxes.
Total	String	False		No	Line total (after discounts).
TotalTax	String	False		No	Line total tax (after discounts).
ParentId	Integer	True		No	Parent/initial order ID for the subscription.
CustomerId	Integer	True	Customers.Id	No	User ID who owns the subscription.
Status	String	True		No	Subscription status.
Product	String	False		Yes	Limit result set to subscriptions assigned a specific product ID.
ReferenceNumber	String	False		Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	Item ID.
SubscriptionId	Integer	False	Subscriptions.Id	No	Subscription ID.
ImageId	String	True		No	Image ID.
ImageSrc	String	True		No	Image Source.
MetaData	String	False		No	Meta data.
Name	String	True		No	Product name.
ParentName	String	False		No	Parent product name if the product is a variation.
Price	Integer	True		No	Product price.
ProductId	Integer	False		No	Product ID.
Quantity	Integer	False		No	Quantity ordered.
Sku	String	True		No	Product SKU.
Subtotal	String	False		No	Line subtotal (before discounts).
SubtotalTax	String	True		No	Line subtotal tax (before discounts).
TaxClass	String	False		No	Slug of the tax class of product.
Taxes	String	True		No	Line taxes.
Total	String	False		No	Line total (after discounts).
TotalTax	String	True		No	Line total tax (after discounts).
VariationId	Integer	False		No	Variation ID, if applicable.
ParentId	Integer	True		No	Parent/initial order ID for the subscription.
CustomerId	Integer	True	Customers.Id	No	User ID who owns the subscription.
Status	String	True		No	Subscription status.
Product	String	False		Yes	Limit result set to subscriptions assigned a specific product ID.
ReferenceNumber	String	False		Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	Unique identifier for the resource
SubscriptionId [KEY]	Integer	False	Subscriptions.Id	No	Subscription ID.
AddedByUser	Boolean	False		No	If true, this note will be attributed to the current user. If false, the note will be attributed to the system.
Author	String	True		No	Subscription note author.
CustomerNote	Boolean	False		No	If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.
DateCreated	Datetime	True		No	The date the subscription note was created, in the site's timezone.
DateCreatedGmt	Datetime	True		No	The date the subscription note was created, as GMT.
Note	String	False		No	Subscription note.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	Unique identifier for the resource.
SubscriptionId	Integer	True	Subscriptions.Id	No	Subscription ID.
BillingAddress1	String	True		No	Billing Address line 1.
BillingAddress2	String	True		No	Billing Address line 2.
BillingCity	String	True		No	Billing City name.
BillingCompany	String	True		No	Billing Company name.
BillingCountry	String	True		No	Billing Country code in ISO 3166-1 alpha-2 format.
BillingEmail	String	True		No	Billing Email address.
BillingFirstName	String	True		No	Billing First name.
BillingLastName	String	True		No	Billing Last name.
BillingPhone	String	True		No	Billing Phone number.
BillingPostcode	String	True		No	Billing Postal code.
BillingState	String	True		No	ISO code or name of the state, province or district.
CartHash	String	True		No	MD5 hash of cart items to ensure orders are not modified.
CartTax	String	True		No	Sum of line item taxes only.
CouponLines	String	True		No	Coupons line data.
CreatedVia	String	True		No	Shows where the order was created.
Currency	String	True		No	Currency the order was created with, in ISO format, e.g USD. Default is the current store currency.
CustomerId	Integer	True		No	User ID who owns the order. Use 0 for guests. Default is 0.
CustomerIpAddress	String	True		No	Customer's IP address.
CustomerNote	String	True		No	Note left by customer during checkout.
CustomerUserAgent	String	True		No	User agent of the customer.
DateCompleted	Datetime	True		No	The date the order was completed, in the site's timezone.
DateCompletedGmt	Datetime	True		No	The date the order was completed, as GMT.
DateCreated	Datetime	True		No	The date the order was created, in the site's timezone.
DateCreatedGmt	Datetime	True		No	The date the order was created, as GMT.
DateModified	Datetime	True		No	The date the order was last modified, in the site's timezone.
DateModifiedGmt	Datetime	True		No	The date the order was modified, as GMT.
DatePaid	Datetime	True		No	The date the order has been paid, in the site's timezone.
DatePaidGmt	Datetime	True		No	The date the order was paid, as GMT.
DiscountTax	String	True		No	Total discount tax amount for the order.
DiscountTotal	String	True		No	Total discount amount for the order.
FeeLines	String	True		No	Fee lines data.
IsEditable	Boolean	True		No	Is editable.
LineItems	String	True		No	Line items data.
MetaData	String	True		No	Meta data.
NeedsPayment	Boolean	True		No	Needs Payment.
NeedsProcessing	Boolean	True		No	Needs Processing
Number	String	True		No	The order's number.
OrderKey	String	True		No	Order key.
OrderType	String	True		No	Order type.
ParentId	Integer	True		No	Parent order ID.
PaymentMethod	String	True		No	Payment method ID.
PaymentMethodTitle	String	True		No	Payment method title.
PaymentUrl	String	True		No	Payment Url.
PricesIncludeTax	Boolean	True		No	Shows if the prices included tax during checkout.
ShippingAddress1	String	True		No	Shipping Address line 1.
ShippingAddress2	String	True		No	Shipping Address line 2.
ShippingCity	String	True		No	Shipping City name.
ShippingCompany	String	True		No	Shipping Company name.
ShippingCountry	String	True		No	Shipping Country code in ISO 3166-1 alpha-2 format.
ShippingFirstName	String	True		No	Shipping First name.
ShippingLastName	String	True		No	Shipping Last name.
ShippingPhone	String	True		No	Shipping Phone
ShippingPostcode	String	True		No	Shipping Postal code.
ShippingState	String	True		No	ISO code or name of the state, province or district.
ShippingLines	String	True		No	Shipping lines data.
ShippingTax	String	True		No	Total shipping tax amount for the order.
ShippingTotal	String	True		No	Total shipping amount for the order.
Status	String	True		No	Order status.
TaxLines	String	True		No	Tax lines data.
Total	String	True		No	Grand total.
TotalTax	String	True		No	Sum of all taxes.
TransactionId	String	True		No	Unique transaction ID.
Version	String	True		No	Version of WooCommerce when the order was made.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	Unique identifier for the resource.
ParentId	Integer	False		No	Parent/initial order ID for the subscription.
BillingAddress1	String	False		No	Billing Address line 1.
BillingAddress2	String	False		No	Billing Address line 2.
BillingCity	String	False		No	Billing City.
BillingCompany	String	False		No	Billing Company.
BillingCountry	String	False		No	Billing Country.
BillingEmail	String	False		No	Billing Email.
BillingFirstName	String	False		No	Billing First Name.
BillingLastName	String	False		No	Billing Last Name.
BillingPhone	String	False		No	Billing Phone.
BillingPostcode	String	False		No	Billing Postcode.
BillingState	String	False		No	Billing State.
BillingInterval	Integer	False		No	The number of billing periods between subscription renewals.
BillingPeriod	String	False		No	The subscription's billing period.
CancelledDateGmt	Datetime	False		No	The date the subscription was cancelled in GMT. In a write context, it must be the format YYYY-mm-dd H:i
CartTax	String	True		No	Sum of line item taxes only.
CouponLines	String	False		No	Coupons line data.
CreatedVia	String	True		No	Where the subscription was created.
Currency	String	False		No	Currency the subscription was created with, in ISO format.
CustomerId	Integer	False	Customers.Id	No	User ID who owns the subscription.
CustomerIpAddress	String	True		No	Customer's IP address.
CustomerNote	String	False		No	Note left by customer during checkout.
CustomerUserAgent	String	True		No	User agent of the customer.
DateCompleted	Datetime	True		No	The date the subscription was completed, in the site's timezone.
DateCompletedGmt	Datetime	False		No	The date the subscription was completed, as GMT.
DateCreated	Datetime	True		No	The date the subscription was created, in the site's timezone.
DateCreatedGmt	Datetime	False		No	The date the subscription was created, as GMT.
DateModified	Datetime	True		No	The date the subscription was last modified, in the site's timezone.
DateModifiedGmt	Datetime	False		No	The date the subscription was modified, as GMT.
DatePaid	Datetime	True		No	The date the subscription has been paid, in the site's timezone.
DatePaidGmt	Datetime	False		No	The date the subscription was paid, as GMT.
DiscountTax	String	True		No	Total discount tax amount for the subscription.
DiscountTotal	String	True		No	Total discount amount for the subscription.
EndDateGmt	Datetime	False		No	The subscription's trial end date in GMT.
FeeLines	String	False		No	Fee lines data.
IsEditable	Boolean	True		No	Is editable.
LastPaymentDateGmt	Datetime	False		No	The subscription's last parent, renewal or switch order date in GMT.
LineItems	String	False		No	Line items data.
MetaData	String	False		No	Meta data.
NeedsPayment	Boolean	True		No	Needs Payment
NeedsProcessing	Boolean	True		No	Needs Processing
NextPaymentDateGmt	Datetime	False		No	The subscription's next payment date in GMT.
Number	String	False		No	The subscription's number.
OrderKey	String	True		No	Order key.
PaymentMethod	String	False		No	Payment method ID.
PaymentMethodTitle	String	False		No	Payment method title.
PaymentRetryDateGmt	Datetime	True		No	The subscription's payment retry date in GMT.
PaymentUrl	String	True		No	Payment Url
PricesIncludeTax	Boolean	True		No	Shows if the prices included tax during checkout.
RemovedLineItems	String	True		No	Item data for items removed by the customer from their my account page.
RequiresManualRenewal	Boolean	True		No	Requires Manual Renewal.
ResubscribedFrom	String	True		No	The ID of the subscription this subscription was resubscribed from.
ResubscribedSubscription	String	True		No	The ID of the new resubscribed subscription.
ShippingAddress1	String	False		No	Address line 1.
ShippingAddress2	String	False		No	Address line 2.
ShippingCity	String	False		No	City name.
ShippingCompany	String	False		No	Company name.
ShippingCountry	String	False		No	Country code in ISO 3166-1 alpha-2 format.
ShippingFirstName	String	False		No	First name.
ShippingLastName	String	False		No	Last name.
ShippingPhone	String	False		No	Phone number.
ShippingPostcode	String	False		No	Postal code.
ShippingState	String	False		No	ISO code or name of the state, province or district.
ShippingLines	String	False		No	Shipping lines data.
ShippingTax	String	False		No	Total shipping tax amount for the subscription.
ShippingTotal	String	False		No	Total shipping amount for the subscription.
StartDateGmt	Datetime	True		No	The subscription's start date in GMT.
Status	String	False		No	Subscription status.
SuspensionCount	Integer	True		No	Suspension Count.
TaxLines	String	True		No	Tax lines data.
Total	String	True		No	Grand total.
TotalTax	String	True		No	Sum of all taxes.
TrialEndDateGmt	Datetime	False		No	The subscription's trial end date in GMT.
Version	String	True		No	Version of WooCommerce when the subscription was made.
TransitionStatus	String	False		Yes	The subscription status to transition to. This will work only for Insert.
PaymentDetails	String	False		Yes	Payment method data. This will work only for Update and Insert.
Product	String	False		Yes	Limit result set to subscriptions assigned a specific product ID.
ReferenceNumber	String	False		Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	Item ID.
SubscriptionId	Integer	False	Subscriptions.Id	No	Subscription ID.
InstanceId	String	False		No	Shipping instance ID.
MetaData	String	False		No	Meta data.
MethodId	String	False		No	Shipping method ID.
MethodTitle	String	False		No	Shipping method name.
TaxStatus	String	True		No	Tax Status.
Taxes	String	True		No	Line taxes.
Total	String	False		No	Line total (after discounts).
TotalTax	String	True		No	Line total tax (after discounts).
ParentId	Integer	True		No	Parent/initial order ID for the subscription.
CustomerId	Integer	True	Customers.Id	No	User ID who owns the subscription.
Status	String	True		No	Subscription status.
Product	String	False		Yes	Limit result set to subscriptions assigned a specific product ID.
ReferenceNumber	String	False		Yes	This column will be used in Bulk operations to get specific values from the Temp tables.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
ActivePluginsAggregate	String	True	No	Active plugins.
PagesAggregate	String	True	No	WooCommerce pages.
EnvironmentHomeUrl	String	True	No	Home URL.
EnvironmentSiteUrl	String	True	No	Site URL.
EnvironmentWcVersion	String	True	No	WooCommerce version.
EnvironmentLogDirectory	String	True	No	Log directory.
EnvironmentLogDirectoryWritable	Boolean	True	No	Is log directory writable? read-only
EnvironmentWpVersion	String	True	No	WordPress version.
EnvironmentWpMultisite	Boolean	True	No	Is WordPress multisite? read-only
EnvironmentWpMemoryLimit	Integer	True	No	WordPress memory limit.
EnvironmentWpDebugMode	Boolean	True	No	Is WordPress debug mode active? read-only
EnvironmentWpCron	Boolean	True	No	Are WordPress cron jobs enabled? read-only
EnvironmentLanguage	String	True	No	WordPress language.
EnvironmentServerInfo	String	True	No	Server info.
EnvironmentPhpVersion	String	True	No	PHP version.
EnvironmentPhpPostMaxSize	Integer	True	No	PHP post max size.
EnvironmentPhpMaxExecutionTime	Integer	True	No	PHP max execution time.
EnvironmentPhpMaxInputVars	Integer	True	No	PHP max input vars.
EnvironmentCurlVersion	String	True	No	cURL version.
EnvironmentSuhosinInstalled	Boolean	True	No	Is SUHOSIN installed? read-only
EnvironmentMaxUploadSize	Integer	True	No	Max upload size.
EnvironmentMysqlVersion	String	True	No	MySQL version.
EnvironmentDefaultTimezone	String	True	No	Default timezone.
EnvironmentFsockopenOrCurlEnabled	Boolean	True	No	Is fsockopen/cURL enabled? read-only
EnvironmentSoapclientEnabled	Boolean	True	No	Is SoapClient class enabled? read-only
EnvironmentDomdocumentEnabled	Boolean	True	No	Is DomDocument class enabled? read-only
EnvironmentGzipEnabled	Boolean	True	No	Is GZip enabled? read-only
EnvironmentMbstringEnabled	Boolean	True	No	Is mbstring enabled? read-only
EnvironmentRemotePostSuccessful	Boolean	True	No	Remote POST successful? read-only
EnvironmentRemotePostResponse	String	True	No	Remote POST response.
EnvironmentRemoteGetSuccessful	Boolean	True	No	Remote GET successful? read-only
EnvironmentRemoteGetResponse	String	True	No	Remote GET response.
DatabaseWcDatabaseVersion	String	True	No	WC database version.
DatabasePrefix	String	True	No	Database prefix.
DatabaseMaxmindGeoipDatabase	String	True	No	MaxMind GeoIP database.
DatabaseTablesAggregate	String	True	No	Database tables.
ThemeName	String	True	No	Theme name.
ThemeVersion	String	True	No	Theme version.
ThemeVersionLatest	String	True	No	Latest version of theme.
ThemeAuthorUrl	String	True	No	Theme author URL.
ThemeIsChildTheme	Boolean	True	No	Is this theme a child theme? read-only
ThemeHasWoocommerceSupport	Boolean	True	No	Does the theme declare WooCommerce support? read-only
ThemeHasWoocommerceFile	Boolean	True	No	Does the theme have a woocommerce.php file? read-only
ThemeHasOutdatedTemplates	Boolean	True	No	Does this theme have outdated templates? read-only
ThemeOverridesAggregate	String	True	No	Template overrides.
ThemeParentName	String	True	No	Parent theme name.
ThemeParentVersion	String	True	No	Parent theme version.
ThemeParentAuthorUrl	String	True	No	Parent theme author URL.
SettingsApiEnabled	Boolean	True	No	REST API enabled? read-only
SettingsForceSsl	Boolean	True	No	SSL forced? read-only
SettingsCurrency	String	True	No	Currency.
SettingsCurrencySymbol	String	True	No	Currency symbol.
SettingsCurrencyPosition	String	True	No	Currency position.
SettingsThousandSeparator	String	True	No	Thousand separator.
SettingsDecimalSeparator	String	True	No	Decimal separator.
SettingsNumberOfDecimals	Integer	True	No	Number of decimals.
SettingsGeolocationEnabled	Boolean	True	No	Geolocation enabled? read-only
SettingsTaxonomiesAggregate	String	True	No	Taxonomy terms for product/order statuses.
SecuritySecureConnection	Boolean	True	No	Is the connection to your store secure? read-only
SecurityHideErrors	Boolean	True	No	Hide errors from visitors? read-only

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
PageName	String	True	No	Name of the page.
PageId	String	True	No	Id of the page.
PageSet	String	True	No	Whether the page is set.
PageExists	String	True	No	Whether the page exists.
PageVisible	String	True	No	Whether the page is visible.
Shortcode	String	True	No	Page short code.
ShortcodeRequired	String	True	No	Whether shortcode is required.
ShortcodePresent	String	True	No	Whether shortcode is present.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A unique identifier for the tool.
Name	String	True	No	Tool name.
Action	String	True	No	What running the tool will do.
Description	String	True	No	Tool description.
Success	Boolean	True	No	Did the tool run successfully?
Message	String	True	No	Tool return message.
Confirm	Boolean	False	No	Confirm execution of the tool. Defaults to false. write-only

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Slug [KEY]	String	True		No	Unique identifier for the resource.
Name	String	False		No	Tax class name. required

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Unique identifier for the resource.
Country	String	False	No	Country ISO 3166 code. See ISO 3166 Codes (Countries) for more details
State	String	False	No	State code.
Postcode	String	False	No	Postcode/ZIP.
City	String	False	No	City name.
Rate	String	False	No	Tax rate.
Name	String	False	No	Tax rate name.
Priority	Integer	False	No	Tax priority. Only 1 matching rate per priority will be used. To define multiple tax rates for a single area you need to specify a different priority per rate. Defaults to 1.
Compound	Boolean	False	No	Whether or not this is a compound rate. Compound tax rates are applied on top of other tax rates. Defaults to false.
Shipping	Boolean	False	No	Whether or not this tax rate also gets applied to shipping. Defaults to true.
Order	Integer	False	No	Indicates the order that will appear in queries.
Class	String	False	No	Tax class. Defaults to standard.
Postcodes	String	False	No	Postcodes/ZIP.
Cities	String	False	No	City names.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Title	String	True	No	Product title.
ProductId	Long	True	No	Product ID.
Quantity	Integer	True	No	Total number of purchases.
StartDate	Date	False	No	Return the report for a specific start date.
EndDate	Date	False	No	Return the report for a specific end date.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Slug	String	True	No	An alphanumeric identifier for the resource.
Name	String	True	No	Review type name.
Total	String	True	No	Amount of reviews.
ReportType	String	True	No	Type of the report. Must be one of: reviews, products, orders, customers, coupons.
StartDate	Date	False	No	Return the report for a specific start date.
EndDate	Date	False	No	Return the report for a specific end date.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Unique identifier for the resource.
Name	String	False	No	A friendly name for the webhook.
Status	String	False	No	Webhook status. Options: active, paused and disabled. Defaults to active.
Topic	String	False	No	Webhook topic.
Resource	String	True	No	Webhook resource.
Event	String	True	No	Webhook event.
HooksAggregate	String	True	No	WooCommerce action names associated with the webhook.
DeliveryUrl	String	False	No	The URL where the webhook payload is delivered.
Secret	String	False	No	Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will Defaults to a MD5 hash from the current user's ID
DateCreated	Datetime	True	No	The date the webhook was created, in the site's timezone.
DateModified	Datetime	True	No	The date the webhook was last modified, in the site's timezone.

Return to Top