Order REST API v2 (legacy)

Important

A newer version of this REST API (v2.1) is available. If you're new to this REST API, use the new version. Alternatively, if you're already using the old version, read about the differences between v2 and v2.1 so you can upgrade.

An order object is the parent object for all other objects and contains attributes that are common to the entire order.

For airlines, an order is a one-to-one mapping to a reservation. The Order REST API matches orders that have the same referenceId values, for example, the Passenger Number Record (PNR), and have orderedAt values (purchase dates) within two days of another.

The following table describes the attributes for an order object:

Attribute	Type	Description	Example(s)
`referenceId`	string	A unique ID generated by your organization to reference the order. For flight orders, this is often the PNR.	`"B94TXY-1"`
`channel`	string	The channel used in the order.	`"AIRPORT_KIOSK", "BRANCH", "CALL_CENTER", "GDS", "KIOSK", "MOBILE_APP", "MOBILE_WEB", "OFFLINE", "OTA", "OTHER", "WEB"`
`pointOfSale`	string (predefined by the client)	The point of sale used in the order.	`"spinflight.com", "spinair.com"`
`status`	string (uppercase)	The status of the order.	`"RESERVED", "PAYMENT_PENDING", "DECLINED", "PURCHASED", "PENDING", "CONFIRMED", "PARTIALY_CONFIRMED", "CANCELLED", "REFUNDED", "PARTIALY_REFUNDED", "UNKNOWN"`
`orderedAt`	ISO 8601 Date/Time UTC	The date and time the order was made.	`"2024-01-01T16:17:16.000Z"`
`currencyCode`	3 letter ISO 4217	The currency the guest used to complete a purchase. Set this to the organization’s default currency.	`"EUR", "NZD","USD"`
`price`	number (currency)	The amount paid for the order.	`50, 30.6`
`paymentType`	string (title case recommended)	The method of payment for the order.	`"Card", "Paypal", "Voucher", "ATM", "Cash", "Other"`
`cardType`	string (title case recommended)	The card type used to pay for the order.	`"Mastercard", "Visa", "Diners", "American Express"`
`contact`	JSON object	The contact associated with the order.	N/A
`consumers`	JSON array of JSON objects	A list of consumers associated with the order.	N/A
`orderItems`	JSON array of JSON objects	A list of one or more items in the order.	N/A

The following are the standard response attributes:

Attribute	Description	Type	Example(s)
`href`	The resource fully qualified location Uniform Resource Identifier (URI).	string	`"https://{apiEndpoint}/v2/{resourceName}/{resourceRef}"`
`ref`	The reference of the resource.	string UUID	`"9d94ee11-7043-4b71-980c-a777d00a7b46"`
`createdAt`	Date and time when the resource was created in Sitecore CDP.	ISO 8601 Date/Time UTC	`"2024-01-01T16:17:16.000Z"`
`modifiedAt`	Date and time when the resource was updated in Sitecore CDP.	ISO 8601 Date/Time UTC	`"2024-01-01T16:17:16.000Z"`

Do you have some feedback for us?

If you have suggestions for improving this article,