WooCommerce · Example Payload

Woocommerce Rest Api Order Example

eCommerceOpen SourceOrdersProductsWordPress

Woocommerce Rest Api Order Example is an example object payload from WooCommerce, with 25 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

idparent_idnumberorder_keystatuscurrencydate_createddate_modifieddate_completeddiscount_totaldiscount_taxshipping_totalshipping_taxcart_taxtotaltotal_taxcustomer_idcustomer_notebillingshippingpayment_methodpayment_method_titletransaction_idline_itemsmeta_data

Example Payload

Raw ↑
{
  "id": 1,
  "parent_id": 1,
  "number": "string-value",
  "order_key": "string-value",
  "status": "pending",
  "currency": "string-value",
  "date_created": "2026-05-03T14:30:00Z",
  "date_modified": "2026-05-03T14:30:00Z",
  "date_completed": "2026-05-03T14:30:00Z",
  "discount_total": "string-value",
  "discount_tax": "string-value",
  "shipping_total": "string-value",
  "shipping_tax": "string-value",
  "cart_tax": "string-value",
  "total": "string-value",
  "total_tax": "string-value",
  "customer_id": 1,
  "customer_note": "string-value",
  "billing": {
    "first_name": "Example Name",
    "last_name": "Example Name",
    "company": "string-value",
    "address_1": "string-value",
    "address_2": "string-value",
    "city": "string-value",
    "state": "string-value",
    "postcode": "string-value",
    "country": "string-value",
    "email": "user@example.com",
    "phone": "string-value"
  },
  "shipping": {
    "first_name": "Example Name",
    "last_name": "Example Name",
    "company": "string-value",
    "address_1": "string-value",
    "address_2": "string-value",
    "city": "string-value",
    "state": "string-value",
    "postcode": "string-value",
    "country": "string-value",
    "email": "user@example.com",
    "phone": "string-value"
  },
  "payment_method": "string-value",
  "payment_method_title": "Example Name",
  "transaction_id": "500123",
  "line_items": [
    "string-value"
  ],
  "meta_data": [
    "string-value"
  ]
}