Skip to content

SENSOR_BASKET

products requires a device with the SENSOR_BASKET sensor — the sensor that detects the shopper’s basket. On a device without it, products is rejected (400).

products=<sku>[:<qty>][;<sku>[:<qty>]…]
  • ;-separated set of <sku>[:<qty>] entries; qty optional, default 1.
  • qty is always the trailing :<digits> when present. A SKU may itself contain :, so quantity is parsed from the right: products=ABC:12:2 is SKU ABC:12, qty 2; products=ABC:12 is SKU ABC, qty 12. A SKU whose own value ends in :<digits> must therefore be sent with an explicit qty, so the trailing number is never mistaken for part of the SKU.
products=sku-123:2;sku-456
# 2x sku-123, 1x sku-456

The basket is matched against flights that target cart contents (skus / items).

An online request carrying just a basket (no demographics):

GET /v1alpha2/ads?playerid=screen-01&key=retailer-acme&products=sku-123:2;sku-456 HTTP/1.1
Accept: application/xml

As sent on the wire (;%3B, :%3A):

GET /v1alpha2/ads?playerid=screen-01&key=retailer-acme&products=sku-123%3A2%3Bsku-456