An order object describes an order you'd like to process with Songbird. This request object can be passed within a request JWT as the 'Payload' field or passed within the browser via Songbird.js.
|Cart||List<CartItem Object>||The items in the cart for the current transaction|
|Consumer||Consumer Object||Consumer object containing BillingAddress, ShippingAddress, and Account|
|Options||Options Object||An object containing any additional option flags|
|OrderDetails||OrderDetails Object||The object that describes basic details about the order|
|Token||Token Object||The token details associated with this transaction|
|Name||AN(128)||Name of Item Purchased.|
|SKU||AN(20)||Merchant SKU of Item.|
|Quantity||N(20)||Count of items being purchased|
|Description||AN(256)||Brief description of the item being purchased|
|Price||N||The price of the item|
A flag that will enable or disable CCA processing for this transaction.
- true - Enables CCA for this transaction
- false - Disables CCA for this transaction
NOTE: While this flag can be used to enable CCA, your merchant account must be configured to process CCA beforehand. This flag simply lets you control when CCA will be used to authenticate consumers.
|OrderNumber||AN(50)||YES||This represents your Order Number or transaction identifier.|
|Amount||N(20)||YES||Unformatted total transaction amount without any decimalization.|
Example: $100.00 = 10000, $123.67 = 12367, $.99 = 99
|CurrencyCode||AN(3)||YES||3 digit ISO 4217 value. Accepts either the Currency Number or Currency Code.|
Example: "840" or "USD"
|OrderDescription||AN(256)||NO||Brief Description of Items purchased.|
|OrderChannel||AN(16)||YES||Specifies the order channel where the transaction was initiated.|
- M – MOTO (Mail Order Telephone Order)
- R – Retail
- S – eCommerce
- P – Mobile Device
- T – Tablet
|TransactionId||AN(50)||C||This value is the TransactionId field from a cmpi_lookup response from Centinel. This field is only used with a hybrid integration. This field is required for a hybrid integration.|
The below objects are general objects and can be found on both the request and response. Their placement within the parent object may differ between request and response however.