WooCommerce · Example Payload

Woocommerce Store Api Checkout Order Example

eCommerceOpen SourceOrdersProductsWordPress

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

Top-level fields

idstatusorder_keyorder_numbercustomer_notebilling_addressshipping_addresspayment_methodpayment_result

Example Payload

Raw ↑ 
{
  "id": 1,
  "status": "active",
  "order_key": "string-value",
  "order_number": "string-value",
  "customer_note": "string-value",
  "billing_address": {
    "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_address": {
    "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_result": {
    "payment_status": "active",
    "payment_details": [
      {}
    ],
    "redirect_url": "https://example.com/path"
  }
}