Skip to content

Payload branch "products"

This branch is always an array, and it contains all the products that have been added to the cart (even "free products" added automatically);

Let's review an example:

js
{
  "context": "...",
  "event": "...",
  "checkout_step": "...",
  "attributes": {...},
  "products": [
    {
      "id": 19499,
      "id_variation": null,
      "id_context": "19499BS",
      "sku": "CL30025",
      "name": "Orologio CLUSE MINUIT - CL30025",
      "name_variation": null,
      "unitprice": "69.64",
      "discount": "10.07",
      "unitofficial_price": "81.93",
      "stock_availability": 102,
      "url": "https://bluespirit.collaudo.biz/orologio-cluse-minuit-cl30025-P19499.htm",
      "url_img": "https://bluespirit.collaudo.biz/i/default/29770/orologio-cluse-minuit-cl30025.jpg",
      "qty": 1,
      "brand": "Cluse",
      "brand_id": 121,
      "collection": "Minuit",
      "collection_id": 1308,
      "cat1_name": "Orologi",
      "cat1_id": 1,
      "cat2_name": "Just time",
      "cat2_id": 9,
      "cat3_name": null,
      "cat3_id": null,
      "gender": "W",
      "ispromotion": true,
      "isnew": false,
      "isoutlet": false,
      "isoutofprod": false,
      "isspecial": false,
      "hasreduction": false,
      "cart_rule_id": null,
      "reduction_percent": null,
      "reduction_amount": null,
      "availability_mode": "shop",
      "availability_shop_code": "871",
      "availability_warehouse": "NG"
    },
    {
      "id": 57385,
      "id_variation": null,
      "id_context": "57385BS",
      "sku": "R8253597037",
      "name": "OROLOGIO PHILIP WATCH CARIBE - R8253597037",
      "name_variation": null,
      "unitprice": "360.66",
      "discount": "0.00",
      "unitofficial_price": "360.66",
      "stock_availability": 111,
      "url": "https://bluespirit.collaudo.biz/orologio-philip-watch-caribe-r8253597037-P57385.htm",
      "url_img": "https://bluespirit.collaudo.biz/i/default/79294/orologio-philip-watch-caribe-r8253597037.jpg",
      "qty": 1,
      "brand": "Philip Watch",
      "brand_id": 39,
      "collection": "Caribe",
      "collection_id": 1400,
      "cat1_name": "Orologi",
      "cat1_id": 1,
      "cat2_name": "Just time",
      "cat2_id": 9,
      "cat3_name": null,
      "cat3_id": null,
      "gender": "M",
      "ispromotion": false,
      "isnew": false,
      "isoutlet": false,
      "isoutofprod": false,
      "isspecial": true,
      "hasreduction": true,
      "cart_rule_id": 275,
      "reduction_percent": "100.000",
      "reduction_amount": "0.000",
      "availability_mode": "online",
      "availability_shop_code": null,
      "availability_warehouse": "01"
    }
  ],
  "carrier": {...},
  "payment": {...},
  "delivery": {...},
  "billing": {...},
  "user": {...},
  "engagements": {...}
}

Variables full details

Here you can find a detailed description of each variable or sub-branch:

VarTypeDescription
idintUnique product id (not cross-tenant)
id_variationint/nullUnique product variation/combination id (not cross-tenant)
id_contextstringSame product id + tenant unique code (cross-tenant)
skustringProduct SKU (cross-tenant)
namestringProduct name (translated)
name_variationstringProduct variation/combination name (translated)
unitpricestringProduct unit price (default currency)
discountstringProduct discount price (default currency)
unitofficial_pricestringProduct official list price (default currency)
stock_availabilityintAvailable stocks (all types)
urlstringProduct page URL (tenant based, translated)
url_imgstringProduct cover image URL (tenant based, CDN)
qtyintProduct quantity in cart
brandstringProduct brand (cross-tenant)
brand_idintUnique Product brand id (not cross-tenant)
collectionstringProduct collection (cross-tenant)
collection_idintUnique Product collection id (not cross-tenant)
cat1_namestringProduct main category (cross-tenant)
cat1_idintUnique Product main category id (not cross-tenant)
cat2_namestringProduct default category (cross-tenant)
cat2_idintUnique Product default category id (not cross-tenant)
cat3_namestring/nullProduct sub category (cross-tenant)
cat3_idint/nullUnique Product sub category id (not cross-tenant)
genderchar(1)Product category gender code:
[M]an / [W]oman / [U]nisex / [C]hild
ispromotionboolProduct status flag "in promotion"
isnewboolProduct status flag "new"
isoutletboolProduct status flag "outlet"
isoutofprodboolProduct status flag "out of production"
isspecialboolProduct cart status flag "special": this item has been added to the cart by a CartRule
hasreductionboolProduct cart status flag "hasreduction": this item is subjected to a reduction by a CartRule
cart_rule_idint/nullThe inner CartRule applied to this item(s)
reduction_percentstring/nullApplied reduction is percentual (1-100)%
reduction_amountstring/nullApplied reduction is a fixed amount
availability_modestringProduct cart given availability mode:
"online", "shop", "offline"
availability_shop_codestring/nullWhen item's availability is "shop", this field will host the "shop code" attached to availability stocks:
Example: "871", "676", ecc.
availability_warehousestringInternal "warehouse code" attached to availability stocks:
Example: "01", "03", "NG", "WM", "W3"

Released under the MIT License.