HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityLog In

Order page

Similar to the checkout page, the order confirmation page must contain all items in the basket, currency, subtotal, shipping, and order total. The page should also include the order number.

Name Description and usage
checkout Element containing checkout specific sub-elements
  items List of checkout items.
    refcode Product reference code
    qty [Number]

Quantity.
   

price

[Number]

Unit price.
  currency Currency code.
  subtotal [Number]

Subtotal amount.
  shipping [Number]

Shipping cost.
  total [Number]

Total amount of checked-out products including shipping cost.

See also Currency codes.

An order page is tracked using the following script.

{
      "type"  : "order",
      "lang"  : "en-gb",
      "order" : {
        "orderNo"  : "ABC-DE-123456",
        "items"    : [{
          "refCode" : "PROD500",
          "qty"     : 2,
          "price"   : 25.5
        }, 
        {
          "refCode" : "PROD600",
          "qty"     : 4,
          "price"   : 12.0
        }],
        "currency" : "GBP",
        "subtotal" : 99.0,
        "shipping" : 3.0,
        "total"    : 102.0
      }
    }

As with the checkout page example, this example illustrates a basket with 6 items in total, 2 units of PROD500 @ £25.50 each and 4 units PROD600 @ £12.00 each, with a sub-total of £99.99, shipping cost of £3.00, a total of £102.00, and the order number ABC-DE-123456.


What’s Next
Did this page help you?