The order data model defines every field associated with an order. When an order is imported into Connect, the connector populates these fields. When an order is exported from Connect, each field is mapped to its counterpart in the external platform.
The data model gives insight into the data saved with each order and what data is available for rule building.
In this article you will learn more about:
Data model
| Field | Description | Example of input | Required |
|---|---|---|---|
| ID | Order ID in Spotler Connect |
"571f3442-5321-45a5- 96bc-3c445edcd498" |
|
| SourceNumber | Order ID in source platform* | "100022992" | Yes |
| Status | Order status | "Completed" | |
| Virtual | Whether the order is virtual or physical | "false" | |
| Anonymized | Anonimization status | "null" | |
| Shipments.*.Identifier | External Shipment ID | "U210001459" | |
| Shipments.*.Provider | Shipment Provider | "UPS" | |
| Shipments.*.Servicelevel | Shipment Servicelevel (i.e. 'signature required') | "8035" | |
| Shipments.*.TrackingCode | Tracking code | "3STQDV4183403" | |
| Shipments.*.TrackingURL | URL of tracking code |
"https://ups/com/tracking /3STQDV4183403" |
|
| Shipments.*.Shipmentdate | Date of shipment | "2021-03-16" | |
| Source | ID of source platform | "7ccc916c-8f1d-4e46-8310-685d03d7ed99" | |
| ShippingAddress.FirstName | First name in shipping address | "Anne" | Yes |
| ShippingAddress.LastName | Last name in shipping address | "De Vries" | Yes |
| ShippingAddress.Email | E‑mail address in shipping address | "vries@company.com" | Either this, or BillingAddress.Email is required |
| ShippingAddress.EmailHash | Hash of E‑mail address | "2a9a9a49916839e16bb…" | |
| ShippingAddress.Phone | Phone number in shipping address | "0612345678" | |
| ShippingAddress.CompanyName | Company name in shipping address | "Spotler Connect" | |
| ShippingAddress.Department | Department in shipping address | "Sales" | |
| ShippingAddress.ToAttentionOf | Attention field in shipping address | "Anne de Vries" | |
| ShippingAddress.Country | Country in shipping address, ISO‑code | "NL" | Yes |
| ShippingAddress.City | City in shipping address | "Amsterdam" | |
| ShippingAddress.ZipCode | Zipcode in shipping address | "1012 RJ" | Yes, if order country is Netherlands |
| ShippingAddress.Street | Street in shipping address | "Nieuwezijds Voorburgwal" | Yes |
| ShippingAddress.Housenumber | Housenumber in shipping address | "147" | |
| ShippingAddress.Housenumber Extension | Housenumber extension in shipping address | "a" | |
| ShippingAddress.Region | Region in shipping address | "Zuid Holland" | |
| ShippingAddress.RegionCode | Region, ISO‑code | "ZH" | |
| BillingAddress.FirstName | First name in billing address | "Heleen" | |
| BillingAddress.LastName | Last name in billing address | "Buntsma" | |
| BillingAddress.Email | E‑mail address in billing address | "buntsma@company.com" | |
| BillingAddress.EmailHash | Hash of E‑mail address | "2a9a9a49916839e16bbb…" | |
| BillingAddress.Phone | Phone number in billing address | "0612345678" | |
| BillingAddress.CompanyName | Company name in billing address | "Spotler Connect" | |
| BillingAddress.Department | Department in billing address | "Administration" | |
| BillingAddress.ToAttentionOf | Attention field in billing address | "Anne de Vries" | |
| BillingAddress.Country | Country in billing address, ISO‑code | "NL" | |
| BillingAddress.City | City in billing address | "Amsterdam" | |
| BillingAddress.ZipCode | Zipcode in billing address | "1012 RJ" | |
| BillingAddress.Street | Street in billing address | "Nieuwezijds Voorburgwal" | |
| BillingAddress.Housenumber | Housenumber in billing address | "147" | |
| BillingAddress.Housenumber Extension | Housenumber extension in billing address | "a" | |
| BillingAddress.Region | Region in billing address | "Zuid Holland" | |
| BillingAddress.RegionCode | Region, ISO‑code | "ZH" | |
| Orderlines.*.Id | Orderline ID | "356897346" | |
| Orderlines.*.ProductId | Orderline product ID | "356897346" | Yes |
| OrderLines.*.Reference | Orderline reference | "Orderline1" | |
| OrderLines.*.ReferenceId | Orderline reference ID | "234234" | |
| Orderlines.*.Quantity | Product quantity | "1" | Yes |
| Orderlines.*.Transactionfee.Amount | Transaction fee | "0" | |
| Orderlines.*.Transactionfee.Currency | Currency of transaction fee | "EUR" | |
| Orderlines.*.Title | Product title | "Paper crown gold" | |
| Orderlines.*.FulfilmentInstruction | Optional instructions for fulfilment | "Use box 3a" | |
| Orderlines.*.Price.Amount | Orderline price | "4.95" | |
| Orderlines.*.Price.Currency | Orderline currency | "EUR" | |
| Orderlines.*.Discount.Amount | Orderline discount | "0.0" | |
| Orderlines.*.Discount.Currency | Discount currency | "EUR" | |
| Orderlines.*.DiscountPrice.Amount | Orderline price after discount | "4.95" | |
| Orderlines.*.DiscountPrice.Currency | Currency of discounted orderline price | "EUR" | |
| Orderlines.*.NetPrice.Amount | Orderline net price | "4.95" | |
| Orderlines.*.NetPrice.Currency | Currency net price | "EUR" | |
| Orderlines.*.Meta | Meta data | Optional, differs per connector | |
| OrderValue | Value of order, excl. VAT or shipping costs* | "4.5" | |
| OrderItems | Number of items in order | "1" | |
| ExternalIdentifiers.{configId} | IDs of order in external platforms | "179815480" | |
| TotalIncludingTaxes | Order total incl. VAT | "7.45" | |
| TotalExcludingTaxes | Order total excl. VAT | "6.57" | |
| TotalTaxes | VAT total | "0.88" | |
| Currency | Currency, ISO‑code | "EUR" | |
| TotalShipping | Shipping costs | "2.95" | |
| ShippingPreference | Indicated Shipping method upon checkout | "UPS Super Saver" | |
| PaymentMethod | Payment Method | "Cash on delivery" | |
| Comment | Comment on order | "It's for my mother's birthday, please wrap it." | |
| OptIn | opt‑in status on order | "true" | |
| OptInAt | Timestamp of opt‑in | "2025-04-02T11:15:23.000000Z" | |
| OptInLevel | Level of opt‑in | "Double" | |
| DiscountCodes | Array of discount codes | "WELCOME10" |