Batch API Offline orders

Order extension data model

When you create a batch file, ensure that you include all required attributes in addition to any attributes from the following table:

Attribute	Description	Type	Example(s)	Insert	Upsert	Migration
`extensions`	A list of data extensions associated with the order. Only one data extension is supported. You can request this feature from your Sitecore representative.	JSON array of JSON objects	N/A	Required	Required	Not supported
`extensions.name`	Set this to `"ext"`	string	`"ext"`	Required	Required	Not supported
`extensions.key`	Set this to `"default"`	string	`"default"`	Required	Required	Not supported
`extensions.attribute`	One or many name/value pair attributes for custom data. The name must follow attribute naming guidelines.	Supported types for the "value": string: `"Hello"`, boolean: `true` or `false`, integer: `9`, number: `99.9`	`"status": "PLACED"`	Required	Required	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

{
   "ref":"056621C2-C955-492D-B7EE-C77C6BDDFDEE",
   "schema":"order",
   "mode":"insert",
   "value":{
      "referenceId":"BET_001-1",
      "channel":"WEB",
      "pointOfSale":"spinbet.com",
      "status":"PURCHASED",
      "orderedAt":"2026-03-07T16:`15:11`.000Z",
      "currencyCode":"EUR",
      "price":100,
      "paymentType":"Card",
      "cardType":"Visa",
      "extensions": [
      {
        "name": "ext",
        "key": "default",
        "promotion": "freeBet",
        "withdrawAllowed": "no"
      }
    ],
      "contact":{
         "identifiers":[
            {
               "provider":"CRM",
               "id":"B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41",
               "expiryDate":"2025-08-23T16:`17:16`.000Z"
            },
            {
               "provider":"CRM",
               "id":"123456789t"
            }
         ]
      },
      "orderItems":[
         {
            "type":"90_EXACT",
            "productId":"CORRECT_SCORE",
            "name":"Exact score after 90 minutes",
            "description":"footballBets",
            "vendor":"Company ABC",
            "orderedAt":"2026-03-07T16:`15:11`.000Z",
            "quantity":1,
            "price":100.00,
            "currencyCode":"EUR",
            "originalPrice":100.00,
            "originalCurrencyCode":"EUR",
            "referenceId":"BET_001-1",
            "status":"PURCHASED"
         }
      ]
   }
}

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