Skip to main content
GET
List Transactions

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1

Page number (1-indexed). Defaults to 1.

page_size
integer
default:50

Number of items per page. Defaults to 50, capped at 100.

Required range: x <= 100
transaction_id
string<uuid>

Filter to a single transaction by its UUID.

order_id
string<uuid>

Filter to transactions associated with this order UUID.

po_number
string

Filter to transactions associated with this purchase order number.

execution_status
enum<string>

Filter by execution status. An invalid value returns 400.

Available options:
SUCCESS,
FAILURE,
RETRY,
PENDING,
SKIP
action_type
enum<string>

Filter by action type. An invalid value returns 400.

Available options:
POST_ORDER_TO,
CREATE_ORDERS_FROM,
INGEST_PURCHASE_ORDER,
INGEST_PURCHASE_ORDER_CHANGE,
FETCH_ORDER_UPDATES,
SEND_SHIPMENT_CONFIRMATION,
SEND_TRACKING,
SEND_PO_ACK,
SEND_ASN,
SEND_INVOICE,
PO_ACK_STATUS_CHECK,
ASN_STATUS_CHECK,
INVOICE_STATUS_CHECK,
INGEST_ORDER_PUT
retailer_ids
string

Comma-separated retailer UUIDs (e.g. a,b,c). Matches transactions scoped to any of the listed retailers.

brand_ids
string

Comma-separated brand UUIDs. Matches transactions scoped to any of the listed brands.

facility_ids
string

Comma-separated facility UUIDs. Matches transactions scoped to any of the listed facilities.

has_error
boolean

When true, returns only transactions with a non-null error message; when false, only those without. Case-insensitive. Independent of execution_status. Any value other than true/false returns 400.

created_at_from
string<date>

Return transactions created on or after this date. Accepts a date or datetime; compared by calendar date, so the whole day is included.

created_at_to
string<date>

Return transactions created on or before this date. Accepts a date or datetime; compared by calendar date, so the whole day is included.

Free-text search. Matches (case-insensitive, partial) against transaction_id, order_id, correlation_id, error_message, and request_url.

order_by
enum<string>
default:created_at

Field to sort by. Defaults to created_at. Unknown values fall back to the default (no error).

Available options:
created_at,
updated_at,
execution_status,
action_type
order_direction
enum<string>
default:desc

Sort direction. Defaults to desc. Unknown values fall back to the default (no error).

Available options:
asc,
desc

Response

Transactions retrieved successfully

Paginated list response.

data
object