Sign in

v1

latestOpenAPI 3.0.02026-07-2421110121.4 KB
Inbox

Inbox

Retrieves the Transactions from the specified Inbox.

Note: The inboxId can be found by logging in to ui.orderful.com and navigating to "Communication Channels".

get/inboxes/{inboxId}/transactions

Path parameters

inboxIdnumber required

Query parameters

limitnumber

Value can be 1-100. Default value is 30. Note: Response size is limited to 200MB. We will return the maximum number of transactions possible without exceeding either the specified limit or the maximum response size.

Headers

orderful-api-versionstring

Specifies the API version to use.

Response

Transactions retrieved successfully.

integrationPayloadIdstring uuid required

Unique identifier for this integration payload.

transactionIdinteger required

Transaction ID.

senderIdstring required

Sender ISA ID.

receiverIdstring required

Receiver ISA ID.

stream'test' | 'live' required

Environment stream.