Order data model for flight
When you create a batch file, ensure that you follow the formatting requirements and include attributes from the following table:
Attribute |
Description |
Type |
Example(s) |
Insert |
Upsert |
Migration |
---|---|---|---|---|---|---|
|
A unique ID generated by your organization to reference the order. |
string |
|
Required |
Required |
Not supported |
|
The channel used in the order. |
string |
|
Required |
Required |
Not supported |
|
The point of sale used in the order. |
string (predefined by the client) |
|
Required |
Required |
Not supported |
|
The status of the order. |
string (uppercase) |
" |
Required |
Optional |
Not supported |
|
The date and time the order was made. |
ISO 8601 Date/Time UTC |
|
Required |
Required if Order does not already exist |
Not supported |
|
The currency the guest used to complete a purchase. Set this to the organization’s default currency. |
3 letter ISO 4217 |
|
Required |
Optional |
Not supported |
|
The amount paid for the order. |
number (currency) |
|
Required |
Optional |
Not supported |
|
The method of payment for the order. |
string (title case recommended) |
|
Required |
Optional |
Not supported |
|
The card type used to pay for the order. |
string (title case recommended) |
|
Required if |
Optional |
Not supported |
|
The contact associated with the order. |
JSON object |
N/A |
Required |
Required |
Not supported |
|
A list of one or more items in the order. |
JSON array of JSON objects |
N/A |
Required |
Required |
Not supported |
{
"ref":"056621C2-C955-492D-B7EE-C77C6BDDFDEE",
"schema":"order",
"mode":"insert",
"value":{
"referenceId":"B94TXY-1",
"channel":"WEB",
"pointOfSale":"myretailsite.com",
"status":"PURCHASED",
"orderedAt":"2024-03-07T16:15:11.000Z",
"currencyCode":"EUR",
"price":100,
"paymentType":"Card",
"cardType":"Visa",
"contact":{
"title":"Mr",
"firstName":"John",
"lastName":"Doe",
"gender":"male",
"dateOfBirth":"1985-12-24T00:00Z",
"email":"[email protected]",
"phoneNumbers":[
"+353161123345",
"+353861123311"
]
},
"orderItems":[
{
"type":"FLIGHT",
"productId":"DUB-LAS",
"name":"flight",
"description":"individualSegments",
"vendor":"Company ABC",
"orderedAt":"2024-03-07T16:15:11.000Z",
"quantity":1,
"price":100.00,
"currencyCode":"EUR",
"originalPrice":100.00,
"originalCurrencyCode":"EUR",
"referenceId":"B94TXY-1",
"status":"PURCHASED",
"consumerTypeCode":"ADT",
"flightSegments":[
{
"id":"1234",
"origin":"DUB",
"destination":"LHR",
"departureDateTime":"2024-08-15T16:00Z",
"arrivalDateTime":"2024-08-15T17:20Z",
"flightNumber":"459",
"fareClass":"Economy",
"fareFamily":"Plus",
"carrier":"FR",
"originDestination":"DUB-LHR"
},
{
"id":"1235",
"origin":"LHR",
"destination":"LAS",
"departureDateTime":"2024-08-15T20:00Z",
"arrivalDateTime":"2024-08-15T22:30Z",
"flightNumber":"460",
"fareClass":"Economy",
"fareFamily":"Plus",
"carrier":"FR",
"originDestination":"LHR-LAS"
}
]
}
]
}
}