Custom List Item
Please contact your CSM or [email protected] to enable this API for your store
Custom items can be added to a list. These custom items may not exist on the default product catalog.
Custom Item
An object containing params required for creating, updating or deleting list items or products.
let customItemWithoutBundle = {
title: "Title for custom item",
price: 25, //custom price
du: du, // url to bundle product
qty: qty || 1,
};
let customItemWithBundle = {
"du": "https://urltostore.com/bundle-handler?sku=bundled-3-for-di-1",
"title": "Bundled board and ski",
"price": 1194, // custom item with bundle price as a sum of bundle items' price
"sku": "bundled-3-for-di-1",
"iu": "https://urltostore.com/cdn/shop/products/Untitled-11_copy_copy_copy_36b27ebe-c3da-4219-9c27-ce8be2f10a34_620x620.jpg?v=1692882252",
"bundle": [
{
"title": "Angus Magtek - 156cm",
"price": 199,
"empi": 8577926889765,
"epi": 46505649635621,
"iu": "https://urltostore.com/cdn/shop/products/Untitled-11_copy_copy_copy_36b27ebe-c3da-4219-9c27-ce8be2f10a34_620x620.jpg?v=1692882252",
"uri": "https://urltostore.com/products/rossignol-angus-magtek-snowboard-2016",
"vendor": "Rossignol"
},
{
"title": "84 CA Skis - 170cm",
"price": 448,
"empi": 8577936556325,
"epi": 46505712386341,
"iu": "https://urltostore.com/cdn/shop/products/Untitled-1_copy_copy_copy_620x620.jpg?v=1692882429",
"uri": "https://urltostore.com/products/rossignol-experience-84-ca-flat-2015?variant=46505712451877",
"vendor": "Rossignol"
},
{
"title": "88 BSLT Skis - 172cm",
"price": 547,
"empi": 8577936720165,
"epi": 46505714778405,
"iu": "https://urltostore.com/cdn/shop/products/Untitled-1_copy_copy_copy_copy_620x620.jpg?v=1692882431",
"uri": "https://urltostore.com/products/rossignol-experience-88-bslt-flat-2015?variant=46505714876709",
"vendor": "Rossignol"
}
]
}
| Argument | Type | Description |
|---|---|---|
| customItem.empi | string | Read-only. Auto-generated by API to map this instance of the custom item. Available in API response |
| customItem.epi | string | Read-only. Auto-generated by API to map this instance of the custom item. Available in API response |
| customItem.title | string | Title of the custom item |
| customItem.du | string | Canonical uri for the custom item. Use a custom page that is able to render the custom item details accurately |
| customItem.price | float | Custom item price. If bundle, sum of price of each bundled item is recommended |
| customItem.iu (optional) | string | Optional. Image URL for the custom item |
| customItem.bundle (optional) | array of bundle items | Optional. Array of bundle items. If non-empty, sets customItem.lity to customBundle else customItem.lity is custom |
| customItem.compareAtPrice (optional) | float | Custom item compare at price. If bundle, sum of price of each bundled item is recommended |
| customItem.qty (optional) | number | Optional. Quantity included for the action |
| customItem.platformitemid (optional) | number/string | Optional. Platform variant id for reference in implementation |
| customItem.cprops (optional) | object | Optional. Map of custom fields. |
| customItem.lity (optional) | string | Read-only. Possible values - custom, customBundle |
Updated 4 days ago