Order data model

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
`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	`"2024-03-07T16:15:11.000Z"`	Required	Required if Order does not already exist	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

RequestResponse

{
   "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":{
         "identifiers":[
            {
               "provider":"IDENTITY_SYSTEM",
               "id":"B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41",
               "expiryDate":"2025-08-23T16:17:16.000Z"
            },
            {
               "provider":"CRM",
               "id":"123456789t"
            }
         ]
      },
      "orderItems":[
         {
            "type":"BET_EXACT_90",
            "productId":"CORRECT_SCORE",
            "name":"Exact score after 90 minutes",
            "description":"footballBets",
            "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"
         }
      ]
   }
}

Do you have some feedback for us?

If you have suggestions for improving this article,