ORorderful
Inbox

Inbox

Changed on

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

Request

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.

idstring uuid nullable required

The Transaction's unique ID. Pass this to the <a href="https://docs.orderful.com/reference/transactionv4controller_gettransaction" target="_blank">transaction</a> and <a href="https://docs.orderful.com/reference/compositetransactioncontroller_createacknowledgment" target="_blank">acknowledgment</a> endpoints — it is the same value as the last path segment of transaction.href, so you never need to parse a URL to get it.

null only in the rare case where the Transaction ID could not be resolved, in which case the transaction object is omitted as well. Orderful still delivers the message, so treat the document as received and skip acknowledgment rather than failing your pipeline. Contact support if you see this on more than an isolated payload.

integrationPayloadIdstring uuid required

Deprecated — will be removed in an upcoming release. Identifies the payload rather than the Transaction, and is not accepted by any endpoint. Use id to identify the Transaction.

transactionIdinteger required

Deprecated — will be removed in an upcoming release. The legacy numeric transaction ID. Use id to identify the Transaction, and the delivery links to report the delivery outcome.

senderIdstring required

Sender ISA ID.

receiverIdstring required

Receiver ISA ID.

stream'test' | 'live' required

Environment stream.

ediTransactionTypestring required

The full Orderful transaction type identifier, for example 850_PURCHASE_ORDER or the EDIFACT ORDERS_PURCHASE_ORDER. Always present. Use this to route the payload when you need to distinguish document variants that share a simplifiedTransactionType — for instance 810_INVOICE and 880_GROCERY_PRODUCTS_INVOICE.

simplifiedTransactionType'PURCHASE_ORDER' | 'PURCHASE_ORDER_ACKNOWLEDGMENT' | 'PURCHASE_ORDER_CHANGE' | 'SHIP_NOTICE' | 'INVOICE' | 'INVENTORY_ADVICE' | 'PRICE_SALES_CATALOG' | 'WAREHOUSE_SHIPPING_ORDER' | 'WAREHOUSE_SHIPPING_ADVICE' | 'WAREHOUSE_STOCK_TRANSFER_SHIPMENT' | 'WAREHOUSE_STOCK_TRANSFER_RECEIPT' nullable required

The simplified alias for ediTransactionType, which groups equivalent X12 and EDIFACT documents under one name. null for any transaction type that has no alias — check for null rather than assuming a value is present, and note that the alias is not a substring of the full identifier (846_INVENTORY_INQUIRY_ADVICE maps to INVENTORY_ADVICE). For the full mapping, see <a href="https://docs.orderful.com/reference/mosaic-schemas" target="_blank">Mosaic Schemas</a>.

Changes

  • fe0e82430746Revision changes
    • info

      added the optional property / to the response with the status

    • info

      response property items/delivery/transactionId deprecated

    • info

      response property items/integrationPayloadId deprecated

    • info

      response property items/transactionId deprecated

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status