v1

latestOpenAPI 3.0.02026-07-2421110121.4 KB

Transaction

Get a Delivery.

Returns the specified transaction delivery. Links to Delivery objects are available in Transactions retrieved from a <a href="https://docs.orderful.com/reference/pollingcontroller_list" target="_blank">Inbox</a> or via an <a href="https://docs.orderful.com/docs/inbound-http" target="_blank">Inbound HTTP Communication Channel</a>.

get/transactions/{transactionId}/deliveries/{deliveryId}

Path parameters

transactionIdnumber required

deliveryIdstring required

Headers

orderful-api-versionstring

Specifies the API version to use.

Response

deliveryIdstring required

Delivery ID

transactionIdnumber required

Transaction ID

hrefstring required

Delivery URL

status'CREATED' | 'SENT' | 'FAILED' | 'DELIVERED' required

Delivery status

createdAtstring date-time required

Datetime the delivery was created

lastUpdatedAtstring date-time required

Datetime the delivery was last updated

notestring required

Delivery note

sendSucceededAtstring date-time required

Datetime the delivery was successfully sent

sendFailedAtstring date-time required

Datetime the delivery permanently failed to be sent

lastConfirmedAtstring date-time required

Datetime the delivery was failed or approved

Example response

{
  "deliveryId": "1aadf1a68-abcd-4981-abcd-012345678901",
  "href": "https://api.orderful.com/transactions/00000/deliveries/1aadf1a68-abcd-4981-abcd-012345678901",
  "status": "CREATED",
  "createdAt": "2025-10-02T16:46:11.943Z",
  "lastUpdatedAt": "2025-10-02T16:46:11.943Z",
  "note": "Transaction received by the ERP",
  "sendSucceededAt": "2025-10-02T16:46:11.943Z",
  "sendFailedAt": "2025-10-02T16:46:11.943Z",
  "lastConfirmedAt": "2025-10-02T16:46:11.943Z"
}