Create or update a saved order

POST

/api/v5/orders

Production

Creates a saved order, or updates the existing one matching “order_id” (and import source). Either “order_id” or “transdirect_order_id” is required. Returns 201 when a new order is created and 200 when an existing order is returned or updated. Requires an API key.

Request Body

object

transdirect_order_id

Existing Transdirect order id to associate with; omit to create new.

integer

order_id

External order reference from the source platform.

string

"" nullable

delivery

Structured delivery recipient details.

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

0 nullable

selected_courier

Courier string_id selected for the order, if any.

string

"" nullable

courier_price

Shipping price for the selected courier, in AUD.

number

0 nullable

paid_time

Timestamp the order was paid (ISO 8601).

string

"" nullable

Responses

200

Existing or updated saved order

object

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

selected_courier

required

Courier string_id selected for the order.

string

nullable

courier_price

required

Any of:

number

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

201

Created saved order

object

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

selected_courier

required

Courier string_id selected for the order.

string

nullable

courier_price

required

Any of:

number

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 body

object

error

required

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

string

401

Missing or invalid API key

500

Booking-backed order create failed

object

error

required

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

string