--- title: "Order data model for flight" slug: "order-data-model-for-flight" abstract: "Describes the standard data model for flight orders (Sitecore CDP Batch API)." --- # Order data model for flight When you create a batch file, ensure that you include all [required attributes](https://doc.sitecore.com/cdp/en/developers/api/batch-api/batch-api-offline-orders/batch-file-formatting-requirements.html#UUID-4499e082-be7d-9ebb-4936-c178936c1e06_para-idm1903351877649584) in addition to any attributes from the following table: ::::tabs :::tab{title="2.1"} | Attribute | Description | Type | Example(s) | Insert | Upsert | Migration | | --- | --- | --- | --- | --- | --- | --- | | `referenceId` | A unique ID generated by your organization to reference the order. | string | `"B94TXY-1"` | Required | Required | Not supported | | `channel` | The channel used in the order. | string | `"AIRPORT_KIOSK", "BRANCH", "CALL_CENTER", "GDS", "KIOSK", "MOBILE_APP", "MOBILE_WEB", "OFFLINE", "OTA", "OTHER", "WEB"` | Required | Required | Not supported | | `pointOfSale` | The point of sale used in the order. | string (predefined by the client) | `"myretailsite.com", "retailsite.co.uk"` | Required | Required | Not supported | | `status` | The status of the order. | string (uppercase) | `"PURCHASED", "PAYMENT_PENDING", "CONFIRMED", "CANCELLED", "REFUNDED"` | Required | Optional | Not supported | | `orderedAt` | The date and time the order was made. | ISO 8601 Date/Time UTC | `"2026-03-07T16:`15:11`.000Z"` | Required | Required | Not supported | | `currencyCode` | The currency the guest used to complete a purchase. Set this to the organization’s default currency. | 3 letter ISO 4217 | `"EUR", "NZD","USD"` | Required | Optional | Not supported | | `price` | The amount paid for the order. | number (currency) | `50, 30.6` | Required | Optional | Not supported | | `paymentType` | The method of payment for the order. | string (title case recommended) | `"Card", "Paypal", "Voucher", "ATM", "Cash", "Other"` | Required | Optional | Not supported | | `cardType` | The card type used to pay for the order. | string (title case recommended) | `"Mastercard", "Visa", "Diners", "American Express"` | Required if `paymentType` is `"Card"` | Optional | Not supported | | `contact` | The contact associated with the order. | JSON object | N/A | Required | Required | Not supported | | `orderItems` | A list of one or more items in the order. | JSON array of JSON objects | N/A | Required | Required | Not supported | ```json { "ref":"056621C2-C955-492D-B7EE-C77C6BDDFDEE", "schema":"order", "mode":"insert", "value":{ "referenceId":"B94TXY-1", "channel":"WEB", "pointOfSale":"myretailsite.com", "status":"PURCHASED", "orderedAt":"2026-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":"john.doe@myretailsite.com", "phoneNumbers":[ "+353161123345", "+353861123311" ] }, "orderItems":[ { "type":"FLIGHT", "productId":"DUB-LAS", "name":"flight", "description":"individualSegments", "vendor":"Company ABC", "orderedAt":"2026-03-07T16:`15:11`.000Z", "quantity":1, "price":100.00, "currencyCode":"EUR", "originalPrice":100.00, "originalCurrencyCode":"EUR", "referenceId":"B94TXY-1-item001", "status":"PURCHASED", "consumerTypeCode":"ADT", "flightSegments":[ { "id":"1234", "origin":"DUB", "destination":"LHR", "departureDateTime":"2026-08-15T16:00Z", "arrivalDateTime":"2026-08-15T17:20Z", "flightNumber":"459", "fareClass":"Economy", "fareFamily":"Plus", "carrier":"FR", "originDestination":"DUB-LHR" }, { "id":"1235", "origin":"LHR", "destination":"LAS", "departureDateTime":"2026-08-15T20:00Z", "arrivalDateTime":"2026-08-15T22:30Z", "flightNumber":"460", "fareClass":"Economy", "fareFamily":"Plus", "carrier":"FR", "originDestination":"LHR-LAS" } ] } ] } } ``` ::: :::tab{title="2.0"} | Attribute | Description | Type | Example(s) | Insert | Upsert | Migration | | --- | --- | --- | --- | --- | --- | --- | | `referenceId` | A unique ID generated by your organization to reference the order. | string | `"B94TXY-1"` | Required | Required | Not supported | | `channel` | The channel used in the order. | string | `"AIRPORT_KIOSK", "BRANCH", "CALL_CENTER", "GDS", "KIOSK", "MOBILE_APP", "MOBILE_WEB", "OFFLINE", "OTA", "OTHER", "WEB"` | Optional | Optional | Not supported | | `pointOfSale` | The point of sale used in the order. | string (predefined by the client) | `"spinflight.com", "spinair.com"` | Optional | Optional | Not supported | | `status` | The status of the order. | string (uppercase) | `"RESERVED", "PAYMENT_PENDING", "DECLINED", "PURCHASED", "PENDING", "CONFIRMED", "PARTIALY_CONFIRMED", "CANCELLED", "REFUNDED", "PARTIALY_REFUNDED", "UNKNOWN"` | Required | Optional | Not supported | | `orderedAt` | The date and time the order was made. | ISO 8601 Date/Time UTC | `"2026-03-07T16:`15:11`.000Z"` | Required | Required | Not supported | | `currencyCode` | The currency the guest used to complete a purchase. Set this to the organization’s default currency. | 3 letter ISO 4217 | `"EUR", "NZD","USD"` | Required | Optional | Not supported | | `price` | The amount paid for the order. | number (currency) | `50, 30.6` | Required | Optional | Not supported | | `paymentType` | The method of payment for the order. | string (title case recommended) | `"Card", "Paypal", "Voucher", "ATM", "Cash", "Other"` | Required | Optional | Not supported | | `cardType` | The card type used to pay for the order. | string (title case recommended) | `"Mastercard", "Visa", "Diners", "American Express"` | Required if `paymentType` is `"Card"` | Optional | Not supported | | `contact` | The contact associated with the order. | JSON object | N/A | Required | Required | Not supported | | `consumers` | A list of consumers associated with the order. | JSON array of JSON objects | N/A | Optional | Optional | Not supported | | `orderItems` | A list of one or more items in the order. | JSON array of JSON objects | N/A | Required | Required | Not supported | | `extensions` | A list of data extensions associated with the order. You must request this feature from your Sitecore representative. | JSON array of JSON objects | N/A | Optional | Optional | Not supported | The Batch API matches orders that have the same `referenceId` values, for example, the Passenger Number Record (PNR), and have `orderedAt` values (purchase dates) within 24 hours of another. ```json { "ref":"056621C2-C955-492D-B7EE-C77C6BDDFDEE", "schema":"order", "mode":"insert", "value":{ "referenceId":"B94TXY-1", "channel":"WEB", "pointOfSale":"spinair.com", "status":"PURCHASED", "orderedAt":"2026-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":"john.doe@sitecore.com", "phoneNumbers":[ "+353161123345", "+353861123311" ], "identifiers":[ { "provider":"IDENTITY_SYSTEM", "id":"B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41", "expiryDate":"2025-08-23T16:`17:16`.000Z" }, { "provider":"Loyalty Program", "id":"123456789t" } ] }, "consumers":[ { "title":"Mr", "firstName":"John", "lastName":"Doe", "identifiers":[ { "provider":"IDENTITY_SYSTEM", "id":"B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41", "expiryDate":"2025-08-23T16:`17:16`.000Z" } ], "orderItems":[ { "referenceId":"B94TXY-1-item001" } ] } ], "orderItems":[ { "type":"FLIGHT", "productId":"DUB-LAS", "orderedAt":"2026-03-07T16:`15:11`.000Z", "quantity":1, "price":100.00, "currencyCode":"EUR", "originalPrice":100.00, "originalCurrencyCode":"EUR", "referenceId":"B94TXY-1-item001", "status":"PURCHASED", "consumerTypeCode":"ADT", "flightSegments":[ { "id":"1234", "origin":"DUB", "destination":"LHR", "departureDateTime":"2026-08-15T16:00Z", "arrivalDateTime":"2026-08-15T17:20Z", "flightNumber":"459", "fareClass":"Economy", "fareFamily":"Plus", "carrier":"FR", "originDestination":"DUB-LHR" }, { "id":"1235", "origin":"LHR", "destination":"LAS", "departureDateTime":"2026-08-15T20:00Z", "arrivalDateTime":"2026-08-15T22:30Z", "flightNumber":"460", "fareClass":"Economy", "fareFamily":"Plus", "carrier":"FR", "originDestination":"LHR-LAS" } ] } ] } } ``` :::::::