The checkout data model defines every field associated with a checkout. When a checkout is imported into Connect, the connector populates these fields. When a checkout 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 checkout 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 | Checkout ID in Spotler Connect | "571f3442-5321-45a5-96bc-3c445edcd498" | |
| Status | Spotler Connect Checkout status | "Completed" | |
| Anonymized | Anonymization status | "null" | |
| Source | Checkout ID in source platform | "7ccc916c-8f1d-4e46-8310-685d03d7ed99" | Yes |
| Address.FirstName | First name in address | "Anne" | |
| Address.LastName | Last name in address | "De Vries" | |
| Address.Email | E-mail address in address | "vries@company.com" | Yes |
| Address.EmailHash | Hash of Email address | "2a9a9a49916839e16bb…" | |
| Address.Phone | Phone number in address | "0612345678" | |
| Address.CompanyName | Company name in address | "Company LTD" | |
| Address.Department | Department in address | "Accounting" | |
| Address.ToAttentionOf | Attention field in address | "Anne de Vries" | |
| Address.Country | Country in address, ISO-code | "NL" | |
| Address.City | City in address | "Amsterdam" | |
| Address.ZipCode | Zipcode in address | "1012 RJ" | |
| Address.Street | Street in address | "Nieuwezijds Voorburgwal" | |
| Address.Housenumber | House number in address | "147" | |
| Address.HousenumberExtension | Extension of House number | "a" | |
| Address.Region | Region | "Zuid Holland" | |
| Address.RegionCode | Region, ISO Code | "ZH" | |
| Comment | Customer note | "Customer note" | |
| Orderlines.*.Id | Orderline ID | "356897346" | |
| Orderlines.*.ProductId | Orderline product ID | "356897346" | Yes |
| Orderlines.*.Virtual | Whether the checkout order is virtual or physical | "false" | |
| OrderLines.*.Reference | Orderline reference | "Orderline1" | |
| OrderLines.*.ReferenceId | Orderline Reference ID | "234234" | |
| Orderlines.*.Sku | Product SKU | "1234567890023" | |
| Orderlines.*.Barcode | Barcode | "3937722892" | |
| Orderlines.*.Quantity | Product quantity | "1" | Yes |
| Orderlines.*.Transactionfee.Amount | Amount of transaction fee | "0" | |
| Orderlines.*.Transactionfee.Currency | Currency of transaction fee | "EUR" | |
| Orderlines.*.Title | Orderline title | "Paper crown gold" | |
| Orderlines.*.FulfilmentInstruction | Instructions for fulfilment | "Ship in box 3a" | |
| Orderlines.*.Price.Amount | Price | "4.95" | |
| Orderlines.*.Price.Currency | Currency | "EUR" | |
| Orderlines.*.Discount.Amount | Discount amount | "0.0" | |
| Orderlines.*.Discount.Currency | Currency of discount | "EUR" | |
| Orderlines.*.DiscountPrice.Amount | Discounted price | "4.95" | |
| Orderlines.*.DiscountPrice.Currency | Currency of discounted price | "EUR" | |
| Orderlines.*.NetPrice.Amount | Net price | "4.95" | |
| Orderlines.*.NetPrice.Currency | Currency of net price | "EUR" | |
| Orderlines.*.Meta | Meta object | Differs per integration | |
| OrderValue | Value of order | "89.98" | |
| OrderItems | Number of products in order | "2" | |
| Meta | Meta | Differs per integration | |
| OptIn | Opt-in value for newsletter | "true" | |
| OptInLevel | Opt-in level | "single_opt_in" | |
| OptInAt | Time of Opt-in | "2021-09-04T22:04:11" | |
| PaymentMethod | Payment method | "PayPal" | |
| OrderSourceId | ID of related order in source | "2342323" | |
| OrderSourceNumber | Order number in source | "#1009" | |
| RecoveryURL | Recovery URL | https://demoshop.com/checkouts/... | |
| Discountcodes.* | Discount code | "TacoTuesday" | |
| TotalIncludingTaxes | Order total incl. VAT | "96.93" | |
| TotalExcludingTaxes | Order total excl. VAT | "80.1" | |
| TotalTaxes | Total of VAT | "16.83" | |
| Currency | Currency, ISO-code | "EUR" | |
| TotalShipping | Shipping costs | "6.95" | |
| ShippingPreference | Indicated shipping method | "PostNL tracked 1109" | |
| TotalDiscount | Total discount | "10.00" | |
| CustomerID | Connect contact linked to checkout | "571f3442-5321-45a5-96bc-3c445edcd498" | |
| OrderID | Connect order linked to checkout | "678f3442-5123-r5b9-96bc-3c445edcd465" |
API documentation
If you are looking into using this data model for your own connector, please visit the API documentation for Spotler Connect.