Order properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Unique identifier for the resource.READ-ONLY |
parent_id |
integer | Parent order ID. |
number |
string | Order number.READ-ONLY |
order_key |
string | Order key.READ-ONLY |
created_via |
string | Shows where the order was created.READ-ONLY |
version |
string | Version of WooCommerce which last updated the order.READ-ONLY |
status |
string | Order status. Options: pending, processing, on-hold, completed, cancelled, refunded, failed and trash. Default is pending. |
currency |
string | 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. |
date_created |
date-time | The date the order was created, in the site’s timezone.READ-ONLY |
date_created_gmt |
date-time | The date the order was created, as GMT.READ-ONLY |
date_modified |
date-time | The date the order was last modified, in the site’s timezone.READ-ONLY |
date_modified_gmt |
date-time | The date the order was last modified, as GMT.READ-ONLY |
discount_total |
string | Total discount amount for the order.READ-ONLY |
discount_tax |
string | Total discount tax amount for the order.READ-ONLY |
shipping_total |
string | Total shipping amount for the order.READ-ONLY |
shipping_tax |
string | Total shipping tax amount for the order.READ-ONLY |
cart_tax |
string | Sum of line item taxes only.READ-ONLY |
total |
string | Grand total.READ-ONLY |
total_tax |
string | Sum of all taxes.READ-ONLY |
prices_include_tax |
boolean | True the prices included tax during checkout.READ-ONLY |
customer_id |
integer | User ID who owns the order. 0 for guests. Default is 0. |
customer_ip_address |
string | Customer’s IP address.READ-ONLY |
customer_user_agent |
string | User agent of the customer.READ-ONLY |
customer_note |
string | Note left by customer during checkout. |
billing |
object | Billing address. See Order – Billing properties |
shipping |
object | Shipping address. See Order – Shipping properties |
payment_method |
string | Payment method ID. |
payment_method_title |
string | Payment method title. |
transaction_id |
string | Unique transaction ID. |
date_paid |
date-time | The date the order was paid, in the site’s timezone.READ-ONLY |
date_paid_gmt |
date-time | The date the order was paid, as GMT.READ-ONLY |
date_completed |
date-time | The date the order was completed, in the site’s timezone.READ-ONLY |
date_completed_gmt |
date-time | The date the order was completed, as GMT.READ-ONLY |
cart_hash |
string | MD5 hash of cart items to ensure orders are not modified.READ-ONLY |
meta_data |
array | Meta data. See Order – Meta data properties |
line_items |
array | Line items data. See Order – Line items properties |
tax_lines |
array | Tax lines data. See Order – Tax lines propertiesREAD-ONLY |
shipping_lines |
array | Shipping lines data. See Order – Shipping lines properties |
fee_lines |
array | Fee lines data. See Order – Fee lines properties |
coupon_lines |
array | Coupons line data. See Order – Coupon lines properties |
refunds |
array | List of refunds. See Order – Refunds propertiesREAD-ONLY |
set_paid |
boolean | Define if the order is paid. It will set the status to processing and reduce stock items. Default is false.WRITE-ONLY |
Order – Billing properties
| Attribute | Type | Description |
|---|---|---|
first_name |
string | First name. |
last_name |
string | Last name. |
company |
string | Company name. |
address_1 |
string | Address line 1 |
address_2 |
string | Address line 2 |
city |
string | City name. |
state |
string | ISO code or name of the state, province or district. |
postcode |
string | Postal code. |
country |
string | Country code in ISO 3166-1 alpha-2 format. |
email |
string | Email address. |
phone |
string | Phone number. |
Order – Shipping properties
| Attribute | Type | Description |
|---|---|---|
first_name |
string | First name. |
last_name |
string | Last name. |
company |
string | Company name. |
address_1 |
string | Address line 1 |
address_2 |
string | Address line 2 |
city |
string | City name. |
state |
string | ISO code or name of the state, province or district. |
postcode |
string | Postal code. |
country |
string | Country code in ISO 3166-1 alpha-2 format. |
Order – Meta data properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Meta ID.READ-ONLY |
key |
string | Meta key. |
value |
string | Meta value. |
Order – Line items properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID.READ-ONLY |
name |
string | Product name. |
product_id |
integer | Product ID. |
variation_id |
integer | Variation ID, if applicable. |
quantity |
integer | Quantity ordered. |
tax_class |
string | Slug of the tax class of product. |
subtotal |
string | Line subtotal (before discounts). |
subtotal_tax |
string | Line subtotal tax (before discounts).READ-ONLY |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts).READ-ONLY |
taxes |
array | Line taxes. See Order – Taxes propertiesREAD-ONLY |
meta_data |
array | Meta data. See Order – Meta data properties |
sku |
string | Product SKU.READ-ONLY |
price |
string | Product price.READ-ONLY |
Order – Tax lines properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID.READ-ONLY |
rate_code |
string | Tax rate code.READ-ONLY |
rate_id |
string | Tax rate ID.READ-ONLY |
label |
string | Tax rate label.READ-ONLY |
compound |
boolean | Show if is a compound tax rate.READ-ONLY |
tax_total |
string | Tax total (not including shipping taxes).READ-ONLY |
shipping_tax_total |
string | Shipping tax total.READ-ONLY |
meta_data |
array | Meta data. See Order – Meta data properties |
Order – Shipping lines properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID.READ-ONLY |
method_title |
string | Shipping method name. |
method_id |
string | Shipping method ID. |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts).READ-ONLY |
taxes |
array | Line taxes. See Order – Taxes propertiesREAD-ONLY |
meta_data |
array | Meta data. See Order – Meta data properties |
Order – Fee lines properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID.READ-ONLY |
name |
string | Fee name. |
tax_class |
string | Tax class of fee. |
tax_status |
string | Tax status of fee. Options: taxable and none. |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts).READ-ONLY |
taxes |
array | Line taxes. See Order – Taxes propertiesREAD-ONLY |
meta_data |
array | Meta data. See Order – Meta data properties |
Order – Coupon lines properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID.READ-ONLY |
code |
string | Coupon code. |
discount |
string | Discount total.READ-ONLY |
discount_tax |
string | Discount total tax.READ-ONLY |
meta_data |
array | Meta data. See Order – Meta data properties |
Order – Refunds properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Refund ID.READ-ONLY |
reason |
string | Refund reason.READ-ONLY |
total |
string | Refund total.READ-ONLY |
Order – Taxes properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID.READ-ONLY |
rate_code |
string | Tax rate code.READ-ONLY |
rate_id |
string | Tax rate ID.READ-ONLY |
label |
string | Tax rate label.READ-ONLY |
compound |
boolean | Show if is a compound tax rate.READ-ONLY |
tax_total |
string | Tax total (not including shipping taxes).READ-ONLY |
shipping_tax_total |
string | Shipping tax total.READ-ONLY |
meta_data |
array | Meta data. See Order – Meta data properties |