Create an Acknowledgment

Acknowledges an inbound Transaction as ACCEPTED or REJECTED.

Every inbound delivery gives you what you need for this call — in the body pushed to your Inbound HTTP Communication Channel and in each item returned by Inbox. Either use the payload's id field as the compositeTransactionId, or POST straight to the finished URL in transaction.acknowledgment.href — they refer to the same Transaction.

integrationPayloadId is a different identifier and will not work here.

Acknowledgments can only be sent once — a Transaction that is already ACCEPTED or REJECTED returns 400. This endpoint applies to Relationships that trade JSON; X12 and EDIFACT Relationships acknowledge through a 997 Functional Acknowledgment instead.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The Transaction UUID, taken from the id field of an inbound delivery. Must be a UUID — numeric transaction IDs are not accepted on this endpoint.

Body Params
string
enum
required

Whether the received Transaction is accepted or rejected.

Allowed:
errors
array of objects

Errors explaining a rejection. Only freeform (00) messages at the /message path are supported today.

errors
Headers
string
required

Your Orderful API key.

string
required
Defaults to v4

Specifies the API version to use. This endpoint requires v4; omitting the header returns 404.

Responses
201

Acknowledgment created successfully.

400

The compositeTransactionId is not a UUID, status is not ACCEPTED or REJECTED, the Transaction has already been acknowledged, or the Relationship trades X12/EDIFACT rather than JSON.

403

Your organization is not the receiver of this Transaction. Only the receiver can acknowledge it.

404

Transaction not found, or the orderful-api-version: v4 header is missing.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!