Hotline: +27 10 085 1127

API Reference

Get Order API

The Get Order endpoint allows you to retrieve the full details of a specific order, including its current status, line items, and shipping tracking information if available.

Retrieve an Order

GET/wp-json/wc/v3/orders/{id}

Path Parameters

ParameterTypeDescription
idintegerThe unique ID of the order resource.

Response Schema (JSON)

{
"id": 727,
"parent_id": 0,
"status": "processing",
"currency": "ZAR",
"version": "8.5.1",
"prices_include_tax": true,
"date_created": "2024-01-18T14:23:17",
"date_modified": "2024-01-18T14:25:00",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "10.00",
"shipping_tax": "1.50",
"cart_tax": "187.50",
"total": "1449.00",
"total_tax": "189.00",
"customer_id": 0,
"order_key": "wc_order_58d2d042d1d",
"billing": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"transaction_id": "",
"meta_data": [
{
    "id": 131,
    "key": "_tracking_number",
    "value": "TRACK123999"
}
],
"line_items": [
{
    "id": 315,
    "name": "Woo Album",
    "product_id": 96,
    "variation_id": 0,
    "quantity": 1,
    "tax_class": "",
    "subtotal": "9.99",
    "subtotal_tax": "0.00",
    "total": "9.99",
    "total_tax": "0.00",
    "taxes": [],
    "meta_data": [],
    "sku": "ALBUM1",
    "price": 9.99
}
]
}