Order
The order entity represents the transaction record for a commerce notification. It contains the order totals, fee breakdowns, tax information, payment processor details, and references to the individual line items.
| Field | Type | Description |
|---|---|---|
key |
String | Unique key for the order. |
code |
String | Order code identifier (e.g., "ORD-352847"). |
status |
String | Status of the order. Values: "draft", "refunded", "pending", "paid", "complete", "voided", "offline". |
receiptNumber |
String | Receipt number for the order. |
description |
String | Description of the order. |
currency |
String | Currency code used for the order (e.g., "AUD", "USD"). |
fee |
Number | Fee charged for the order. |
feePlatform |
Number | Platform fee charged for the order. |
feeGateway |
Number | Gateway fee charged for the order. |
tax |
Number | Total tax for the order. |
taxCommerce |
Number | Tax charged by commerce. |
taxPlatform |
Number | Tax charged by the platform. |
taxGateway |
Number | Tax charged by the gateway. |
total |
Number | Total amount for the order. |
items |
Array of Order item | List of items included in the order. |
processor |
String | Payment processor used for the order (e.g., "generic", "stripe"). |
processorTransactionId |
String | Transaction ID from the payment processor. |
cardInformationType |
String | Type of card used for payment. |
cardInformationCountry |
String | Country of the card used for payment. |
cardInformationPan |
String | Masked PAN (primary account number) of the card. |
cardInformationCardholderName |
String | Name of the cardholder. |
cardInformationCardholderExpiry |
String | Expiry date of the card in MMYY format. |
custom |
Object | Custom metadata for the order. |
questions |
Array of Question | Questions answered by the customer. |
marketing |
Marketing | Marketing information related to the order. |
related |
Relationship | Relationship information linking to related transactions. |
createdAt |
DateTime | Date when the order was created. |
modifiedAt |
DateTime | Date when the order was last modified. |