Fields listing for WooCommerce

Billing Address 2

Billing Address 2

Billing Company Name

Billing Country

Billing Email

Billing First Name

Billing Last Name

Billing Email

Billing Post code

Billing State

The amount of discount. Should always be numeric, even if setting a percentage.

Coupon code. mandatory

The date the coupon was created, in the site's timezone. read-only

The date the coupon was created, as GMT. read-only

The date the coupon expires, in the site's timezone.

The date the coupon expires, as GMT.

The date the coupon was last modified, in the site's timezone. read-only

The date the coupon was last modified, as GMT. read-only

Coupon description.

Determines the type of discount that will be applied. Options: percent, fixed_cart and fixed_product. Default is fixed_cart.

List of email addresses that can use this coupon.

If true, this coupon will not be applied to items that have sale prices. Default is false.

List of category IDs the coupon does not apply to.

List of product IDs the coupon cannot be used on.

If true and if the free shipping method requires a coupon, this coupon will enable free shipping. Default is false.

Unique identifier for the object. read-only

If true, the coupon can only be used individually. Other applied coupons will be removed from the cart. Default is false.

Max number of items in the cart the coupon can be applied to.

Maximum order amount allowed when using the coupon.

Minimum order amount that needs to be in the cart before coupon applies.

List of category IDs the coupon applies to.

List of product IDs the coupon can be used on.

Number of times the coupon has been used already. read-only

How many times the coupon can be used in total.

How many times the coupon can be used per customer.

List of user IDs (or guest email addresses) that have used the coupon. read-only

Avatar URL. read-only

The date the customer was created, in the site's timezone. read-only

The date the customer was created, as GMT. read-only

The date the customer was last modified, in the site's timezone. read-only

The date the customer was last modified, as GMT. read-only

The email address for the customer. mandatory

Customer first name.

Unique identifier for the resource. read-only

Is the customer a paying customer? read-only

Customer last name.

Customer role. read-only

Year, month, and day.

Day of the year

Week of the year

Hour of the day

Month and day

Month of the year

Device type used to place the order. read-only

Referrer used to place the order. read-only

Number of sessions used to place the order. read-only

Number of pages viewed during the sessions used to place the order. read-only

Source type used to place the order. read-only

User agent of the device used to place the order. read-only

UTM medium used to place the order. read-only

UTM source used to place the order. read-only

MD5 hash of cart items to ensure orders are not modified. read-only

Sum of line item taxes only. read-only

Shows where the order was created. read-only

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. Default is USD.

User ID who owns the order. 0 for guests. Default is 0.

Customer's IP address. read-only

Note left by customer during checkout.

User agent of the customer. read-only

The date the order was completed, in the site's timezone. read-only

The date the order was completed, as GMT. read-only

The date the order was created, in the site's timezone. read-only

The date the order was created, as GMT. read-only

The date the order was last modified, in the site's timezone. read-only

The date the order was last modified, as GMT. read-only

The date the order was paid, in the site's timezone. read-only

The date the order was paid, as GMT. read-only

Total discount tax amount for the order. read-only

Total discount amount for the order. read-only

Unique identifier for the resource. read-only

Item ID.

Order Line Product Id.

Order Line Product name.

Product price.

Order Line Product Quantity

Product SKU.

Order Line Product Variation Id.

Line subtotal (before discounts).

Line subtotal tax (before discounts).

Slug of the tax class of product.

Line total (after discounts).

Line total tax (after discounts).

Order number. read-only

Order key. read-only

Parent order ID.

Payment method ID.

Payment method title.

True the prices included tax during checkout. read-only

Define if the order is paid. It will set the status to processing and reduce stock items. Default is false. write-only

Order Shipping Lines ID

Order Shipping Method ID

Order Shipping Method Title

Order Shipping Method Total

Order Shipping Method Total Tax

Total shipping tax amount for the order. read-only

Total shipping amount for the order. read-only

Order status. Options: pending, processing, on-hold, completed, cancelled, refunded, failed and trash. Default is pending.

Grand total. read-only

Sum of all taxes. read-only

Unique transaction ID.

Version of WooCommerce which last updated the order. read-only

List of attributes. See Product - Attributes properties

Reviews average rating. read-only

Shows if the product is on backordered. read-only

If managing stock, this controls if backorders are allowed. Options: no, notify and yes. Default is no.

Shows if backorders are allowed. read-only

Product external button text. Only for external products.

Catalog visibility. Options: visible, catalog, search and hidden. Default is visible.

List of categories. See Product - Categories properties

List of cross-sell products IDs.

The date the product was created, in the site's timezone. read-only

The date the product was created, as GMT. read-only

The date the product was last modified, in the site's timezone. read-only

The date the product was last modified, as GMT. read-only

Start date of sale price, in the site's timezone.

Start date of sale price, as GMT.

End date of sale price, in the site's timezone.

End date of sale price, as GMT.

Defaults variation attributes. See Product - Default attributes properties

Product description.

Number of days until access to downloadable files expires. Default is -1.

Number of times downloadable files can be downloaded after purchase. Default is -1.

If the product is downloadable. Default is false.

List of downloadable files. See Product - Downloads properties

Product external URL. Only for external products.

Featured product. Default is false.

List of grouped products ID.

Product height.

Unique identifier for the resource. read-only

List of images. See Product - Images properties

Product Length.

Stock management at product level. Default is false.

Menu order, used to custom sort products.

Product name.

Shows if the product is on sale. read-only

Product parent ID.

Product URL. read-only

Current product price. read-only

Price formatted in HTML. read-only

Shows if the product can be bought. read-only

Optional note to send the customer after purchase.

Amount of reviews that the product have. read-only

Product regular price.

List of related products IDs. read-only

Allow reviews. Default is true.

Product sale price.

Shipping class slug.

Shipping class ID. read-only

Shows if the product need to be shipped. read-only

Shows whether or not the product shipping is taxable. read-only

Product short description.

Unique identifier.

Product slug.

Allow one item to be bought in a single order. Default is false.

Product status (post status). Options: draft, pending, private and publish. Default is publish.

Stock quantity.

Controls the stock status of the product. Options: instock, outofstock, onbackorder. Default is instock.

List of tags. See Product - Tags properties

Tax class.

Tax status. Options: taxable, shipping and none. Default is taxable.

Amount of sales. read-only

Product type. Options: simple, grouped, external and variable. Default is simple.

List of up-sell products IDs.

List of variations IDs. read-only

Shows if the variation is on backordered. read-only

If managing stock, this controls if backorders are allowed. Options: no, notify and yes. Default is no.

Shows if backorders are allowed. read-only

The date the variation was created, in the site's timezone. read-only

The date the variation was created, as GMT. read-only

The date the variation was last modified, in the site's timezone. read-only

The date the variation was last modified, as GMT. read-only

Start date of sale price, in the site's timezone.

Start date of sale price, as GMT.

End date of sale price, in the site's timezone.

End date of sale price, as GMT.

Variation description.

Number of days until access to downloadable files expires. Default is -1.

Number of times downloadable files can be downloaded after purchase. Default is -1.

If the variation is downloadable. Default is false.

Unique identifier for the resource. read-only

Variation image data. See Product variation - Image properties

Stock management at variation level. Default is false.

Menu order, used to custom sort products.

Shows if the variation is on sale. read-only

Variation URL. read-only

Current variation price. read-only

Shows if the variation can be bought. read-only

Variation regular price.

Variation sale price.

Shipping class slug.

Shipping class ID. read-only

Unique identifier.

Variation status. Options: draft, pending, private and publish. Default is publish.

Stock quantity.

Controls the stock status of the product. Options: instock, outofstock, onbackorder. Default is instock.

Tax class.

Tax status. Options: taxable, shipping and none. Default is taxable.

If the variation is virtual. Default is false.

Variation weight.

If the product is virtual. Default is false.

Product weight.

Product width.

Quarter of the year

Total refund amount. Optional. If this parameter is provided, it will take precedence over line item totals, even when total of line items does not matches with this amount.

When true, the payment gateway API is used to generate the refund. Default is true. write-only

The date the order refund was created, in the site's timezone. read-only

The date the order refund was created, as GMT. read-only

Unique identifier for the resource. read-only

Line items data. See Order refund - Line items properties

Meta data. See Order refund - Meta data properties

Reason for refund.

User ID of user who created the refund.

If the payment was refunded via the API. See api_refund. read-only

shipping Address 2

shipping Address 2

shipping Company Name

shipping Country

shipping Email

shipping First Name

shipping Last Name

shipping Email

shipping Post code

shipping State

Gross sales in the period.

Net sales in the period.

Total of coupons used

Total of customers who placed orders

Total of items purchased.

Total of orders placed.

Total of refunds

Total charged for shipping.

Total charged for taxes.

Get the Store Id.

Tax Lines 1 ID

Tax Lines Compound

Tax Lines Label

Tax Lines Number

Tax Lines Rate Code

Tax Lines Rate Id

Tax Lines Shipping Tax Total

Total order CA

Total Order Number

Week of the year

Week of the year

Year such as 2017.

Year and month.

Year, month, day, and hour.

Year and quarter.

Year and week.