ORorderful
Transaction

Get a Transaction Message

Changed on

Redirects to a download URL for the Transaction's message content. Most HTTP clients follow the 302 redirect automatically, so a plain GET returns the content directly.

What downloads depends on how the Transaction is backed: Relationships that trade JSON return the JSON document, while X12 and EDIFACT Relationships return the EDI file. As the sender you read back the content you posted; as the receiver you get the message as it is delivered to you.

The download URL is short-lived — it expires 5 minutes after it is issued. Follow it right away rather than storing it, and request this endpoint again whenever you need a fresh one.

get/transactions/{compositeTransactionId}/message

Request

Path parameters

compositeTransactionIdstring uuid required

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

Headers

orderful-api-keystring required

Your Orderful API key.

orderful-api-versionstring required

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

Changes