Get order by ID

Retrieve a completed order by its unique identifier. When cartId is provided as a query parameter, the server validates it against the hold transaction and grants access without requiring customer authentication.

By default, the purchaser sees all items in the order. An invited guest can access only the items to which they were invited.

Authentication

X-TT-API-Keystring
API Key authentication via header

Path parameters

orderIdstringRequiredformat: "^[1-9]\d*$">=1 character

Headers

X-TT-PlatformenumRequired
Identifies the platform the request comes from.
Allowed values:

Query parameters

cartIdstringOptionalformat: "(?i)^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
Cart ID for authorization. Grants access without customer authentication.

Response

Order found successfully.
idstring
Unique identifier for the order
confirmationNumberstring

Human-readable confirmation number for customer support and emails

customerIdstring
Identifier for the customer who placed this order
contactobject
Contact information for order fulfillment
itemslist of objects
Items purchased in this order. By default, the purchaser sees all items in the order. An invited guest can access only the items to which they were invited.
receiptLineslist of objects

Server-ordered display lines for receipt rendering. Always includes SubtotalLine. Conditionally: VoucherLine, ProtectionLine.

totalobject

Monetary amount in minor units (cents for USD). Never uses floating point to avoid precision errors.

statusenum
Current status of the order
createdAtstring

When the order was created (UTC)

protectionobjectOptional
Protection covering all items. Null if not added.
totalTaxesobjectOptional

Monetary amount in minor units (cents for USD). Never uses floating point to avoid precision errors.

cancellationVoucherobjectOptional
Credit voucher issued when the order was cancelled or exchanged