Batch API Offline orders

Flight segments data model

When you create a batch file, ensure that you include all required attributes from the order item data model in addition to any flight segments attributes from the following table:

Attribute	Description	Type	Example(s)	Required/optional	Upsert	Migration
`id`	An ID to identify the flight segment.	string	`"1234"`	Required	Not supported	Not supported
`origin`	The IATA airport or city origin code of the flight segment.	IATA airport or city code (uppercase)	`"DUB", "LHR", "BCN"`	Required	Not supported	Not supported
`destination`	The IATA airport or city destination code of the flight segment.	IATA airport or city code (uppercase)	`"DUB", "LHR", "BCN"`	Required	Not supported	Not supported
`departureDateTime`	The local departure date and time of the flight segment. You must pass this value in as the local departure date/time and include the Z at the end, even though it is not UTC time.	ISO 8601 date/time	`"2026-08-23T16:17Z"`	Required	Not supported	Not supported
`arrivalDateTime`	The local arrival date and time of the flight segment. You must pass this value in as the local departure date/time and include the Z at the end, even though it is not UTC time.	ISO 8601 date/time	`"2026-08-23T16:17Z"`	Required	Not supported	Not supported
`flightNumber`	The marketing flight number for the flight segment.	string	`"12345"`	Required	Not supported	Not supported
`fareClass`	The fare class of the flight segment.	string (title case recommended)	`"Economy", "Business", "First Class"`	Required	Not supported	Not supported
`fareFamily`	The fare family of the flight segment.	string (title case recommended)	`"Economy Plus"`	Optional	Not supported	Not supported
`bookingClass`	The booking class of the flight segment.	string (uppercase)	`"Y7 K5 M4 T6 E3"`	Optional	Not supported	Not supported
`equipmentType`	The equipment type of the flight segment.	string (uppercase)	`"BOEING 777"`	Optional	Not supported	Not supported
`carrier`	The marketing carrier code for the flight segment.	IATA airline code (uppercase)	`"EI", "FR", "BA"`	Required	Not supported	Not supported
`originDestination`	The origin and destination of the flight segment.	string (uppercase)	`"DUB-JFK"`	Optional	Not supported	Not supported
`operatingCarrier`	The operating carrier code for the flight segment.	IATA airline code (uppercase)	`"EI", "FR", "BA"`	Optional	Not supported	Not supported
`operatingCarrierFlightNumber`	The operating carrier flight number for the flight segment.	string	`"5678"`	Optional	Not supported	Not supported

{
   "ref":"056621C2-C955-492D-B7EE-C77C6BDDFDEE",
   "schema":"order",
   "mode":"insert",
   "value":{
      "referenceId":"B94TXY",
      "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":"[email protected]",
         "phoneNumbers":[
            "+353161123345",
            "+353861123311"
         ],
         "identifiers":[
            {
               "provider":"SITECORE_IDENTITY_SYSTEM",
               "id":"B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41",
               "expiryDate":"2025-08-23T16:`17:16`.000Z"
            },
            {
               "provider":"Sitecore Loyalty Program",
               "id":"123456789t"
            }
         ]
      },
      "consumers":[
         {
            "title":"Mr",
            "firstName":"John",
            "lastName":"Doe",
            "identifiers":[
               {
                  "provider":"SITECORE_IDENTITY_SYSTEM",
                  "id":"B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41",
                  "expiryDate":"2025-08-23T16:`17:16`.000Z"
               }
            ],
            "orderItems":[
               {
                  "referenceId":"B94TXY-1"
               }
            ]
         }
      ],
      "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",
            "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"
               }
            ]
         }
      ]
   }
}

If you have suggestions for improving this article, let us know!