Order page
Name | | | | Description and usage |
|---|---|---|---|---|
order | | | | Element containing checkout-specific sub-elements. |
| orderNo | | | [String] Order confirmation code or number. |
| items | | | List of checkout items. |
| | refCode | | Product reference code. The refCode must exactly match the refCode (guid) specified in the product catalog feed. Also, if you have a custom feed, contact Optimizely to find out which field from the feed is used as a product identifier. |
| | qty | | [Number] Quantity. |
| | price | | [Number] Unit price. |
| | variant | | [Optional] The product variant’s SKU code. Alternatively, you can supply the product variant’s attributes colour and size. By arrangement with Optimizely, these can be replaced by another product attribute. Sub-elements are of the type [String]. Available from version 1.3 of the Server-to-Server API. See Variant tracking. |
| currency | | | Currency code. See Currency codes. |
| subtotal | | | [Number] Subtotal amount. |
| shipping | | | [Number] Shipping cost. |
| total | | | [Number] Total amount of the checkout. |
Order page tracking request example.
{
"type" : "order",
"ip" : "10.42.37.139",
"session" : "123456789012|a1b2c3d4e5A6B7C8D9E0f1g2h3i4j5F1G2H3I4J5k1l",
"cuid" : "09876543210|Z0Y9X8W7V6z5y4x3w2v1U0T9S8R7Q6u5t4s3r2q1P0O",
"site" : "retailer",
"clientToken" : "1234abcd5678",
"channel" : "web",
"lang" : "en-gb",
"currentURI" : "www.retailer.com/orderconfirmation.html",
"previousURI" : "www.retailer.com/checkout.html",
"userAgent" : "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",
"order" : {
"orderNo" : "ABC-DE-123456",
"items" : [
{ "refCode" : "RC123",
"qty" : 5,
"price" : 50.5,
"variant" : { "sku" : "sku123" }
},
{ "refCode" : "RC124",
"qty" : 8,
"price" : 52.5,
"variant" : { "sku" : "sku124" }
}
],
"currency" : "GBP",
"subtotal" : 103,
"shipping" : 11.75,
"total" : 114.75
}
}