Update a saved order

PUT

/api/v5/orders/{id}

• Production

Updates a saved order. A body containing only “transdirect_order_status” performs a status-only change; otherwise order, buyer and delivery fields are updated. Supplying a courier plus transdirect_order_id links the order to a booking and stores the courier price. Requires an API key.

Parameters

Path Parameters

id

required

string

/^\d+$/

Example

88

Numeric ID of the saved order.

Request Body

Any of:

object

object

transdirect_order_status

New order status to set (e.g. “processing”, “completed”, “cancelled”).

string

nullable >= 1 characters

object

object

transdirect_order_id

Transdirect order id to update.

integer

order_id

External order reference from the source platform.

string

nullable

delivery

Structured delivery recipient details to update.

object

name

Delivery recipient name.

string

nullable

email

Delivery recipient email.

string

nullable

phone

Delivery recipient phone number.

string

nullable

address

Delivery recipient full address.

string

nullable

delivery_client_name

Delivery recipient name (flat alias of delivery.name).

string

nullable

delivery_client_email

Delivery recipient email (flat alias of delivery.email).

string

nullable

delivery_client_phone

Delivery recipient phone (flat alias of delivery.phone).

string

nullable

delivery_client_address

Delivery recipient address (flat alias of delivery.address).

string

nullable

buyer_name

Name of the buyer who placed the order.

string

nullable

buyer_email

Email of the buyer who placed the order.

string

nullable

goods_summary

Short summary of the goods purchased.

string

nullable

goods_dump

Raw serialised goods/line-item data from the source platform.

string

nullable

imported_from

Source of the order import (e.g. “shopify”, “csv”).

string

nullable

purchased_time

Timestamp the order was purchased (ISO 8601).

string

nullable

sale_price

Order sale price in AUD.

number

nullable

selected_courier

Courier string_id selected for the order.

string

nullable

courier_price

Shipping price for the selected courier, in AUD.

number

nullable

paid_time

Timestamp the order was paid (ISO 8601).

string

nullable

transdirect_order_status

New order status to set (e.g. “processing”, “completed”).

string

nullable

Responses

200

Updated saved order

object

id

required

Order record identifier.

number

transdirect_order_id

required

Linked Transdirect order id, if any.

number

nullable

transdirect_member_id

required

Member who owns the order.

number

transdirect_order_status

required

Current order status (e.g. “new”, “processing”, “completed”).

string

nullable

order_id

required

External order reference from the source platform.

string

nullable

goods_summary

required

Short summary of the goods purchased.

string

nullable

goods_dump

required

Raw serialised goods/line-item data from the source platform.

string

nullable

imported_from

required

Source of the order import (e.g. “shopify”, “csv”).

string

nullable

imported_time

required

Timestamp the order was imported (ISO 8601).

string

nullable

purchased_time

required

Timestamp the order was purchased (ISO 8601).

string

nullable

sale_price

required

Any of:

number

number

string

string

unknown

nullable

selected_courier

required

Courier string_id selected for the order.

string

nullable

courier_price

required

Any of:

number

number

string

string

unknown

nullable

paid_time

required

Timestamp the order was paid (ISO 8601).

string

nullable

buyer_name

required

Name of the buyer who placed the order.

string

nullable

buyer_email

required

Email of the buyer who placed the order.

string

nullable

delivery

required

Delivery recipient details for the order.

object

name

required

Delivery recipient name.

string

nullable

email

required

Delivery recipient email.

string

nullable

phone

required

Delivery recipient phone number.

string

nullable

address

required

Delivery recipient full address.

string

nullable

last_updated

required

Timestamp the order was last updated (ISO 8601).

string

nullable

400

Invalid order id or body

object

error

required

Human-readable error message describing why the order request failed.

string

401

Missing or invalid API key

404

Order not found

object

error

required

Human-readable error message describing why the order request failed.

string

500

Booking-backed order update failed

object

error

required

Human-readable error message describing why the order request failed.

string