Orders

The Orders resource provides full CRUD for WooCommerce orders with HPOS support.

Endpoints

Method	Path	Description
GET	/woo/orders	List orders
GET	/woo/orders/{id}	Get order
POST	/woo/orders	Create order
PUT / PATCH	/woo/orders/{id}	Update order
DELETE	/woo/orders/{id}	Delete order

List query parameters

Parameter	Type	Default	Description
fields	string	default set	Comma-separated field names
status	string|array	—	Filter by status (comma-separated)
customer_id	int	—	Filter by customer ID
search	string	—	Wildcard search
sort	string	-date_created	Sort field, prefix - for DESC
page	int	1	Page number
per_page	int	20	Items per page (max 100)

Allowed sort fields: date_created, date_modified, id, total

Available fields

List defaults: id, number, status, currency, total, customer_id, date_created, date_modified

All fields: id, number, status, currency, total, total_tax, customer_id, billing_email, payment_method, payment_method_title, date_created, date_modified, billing, shipping, customer_note, meta_data, line_items

Create / Update payload

{
  "status": "processing",
  "customer_id": 12,
  "currency": "USD",
  "payment_method": "bacs",
  "payment_method_title": "Direct Bank Transfer",
  "billing": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@example.com",
    "phone": "+1234567890",
    "address_1": "123 Main St",
    "city": "Springfield",
    "state": "IL",
    "postcode": "62701",
    "country": "US"
  },
  "shipping": { },
  "customer_note": "Leave at door",
  "set_paid": true,
  "line_items": [
    {
      "product_id": 42,
      "quantity": 2
    }
  ],
  "meta_data": [
    { "key": "source", "value": "mobile-app" }
  ]
}

Line items

Each line item accepts: product_id (required), variation_id, quantity, subtotal, total, meta_data.

On update, providing line_items replaces all existing items. Totals are recalculated automatically.

set_paid

When set_paid is true, payment_complete() is called after save. This triggers WooCommerce stock reduction and status transitions.

Address fields

Both billing and shipping accept: first_name, last_name, company, address_1, address_2, city, state, postcode, country, email, phone.

Delete mode (v0.3.0)

Configurable via deleteMode on the registrar:

• 'force' (default) — permanently deletes the order via wp_delete_post(..., true)
• 'trash' — sends the order to the trash so it can be restored from WP admin

Protected meta keys (v0.3.0)

Meta keys starting with _ (e.g., _order_total, _payment_method_title) are not returned in responses and are rejected on write by default.