List saved orders

GET

/api/v5/orders

• Production

Lists the authenticated member’s imported e-commerce orders (Shopify, WooCommerce, CSV and similar), newest first and capped at 50. Requires an API key. Optionally filter by import time and choose the sort column.

Parameters

Query Parameters

since

Only return orders imported at or after this time. Accepts an ISO 8601 datetime, or a “YYYY-MM-DD HH:MM:SS” value which is treated as UTC.

string

Only return orders imported at or after this time. Accepts an ISO 8601 datetime, or a “YYYY-MM-DD HH:MM:SS” value which is treated as UTC.

sort

Column to sort ascending by (e.g. id, imported_time, sale_price, buyer_name). Defaults to newest first (imported_time descending).

string

Column to sort ascending by (e.g. id, imported_time, sale_price, buyer_name). Defaults to newest first (imported_time descending).

Responses

200

Saved orders

Array<object>

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 query

object

error

required

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

string

401

Missing or invalid API key