Product
Product contains a linked internet address which routes to the Product diplay page, which contains all the details about the product. On this page, we'll dive into the different Product endpoints you can use to view Product diplay Page programmatically.
Get product details by ID
This endpoint allows you to retrieve a list of product details by it's unique Id.
Developers - API Operations:
Operation | Endpoint | Response |
---|---|---|
Product Details | /api/v2/catalog/product/:id | Get product details by id. |
Required attributes
- Name
id
- Type
- string
- Description
Unique Id of the product
Response attributes
- Name
statusCode
- Type
- number
- Description
Status code of the response
- Name
status
- Type
- string
- Description
Status of the response
- Name
errors
- Type
- array
- Description
List of errors in the response
- Name
success
- Type
- boolean
- Description
Success status of the response
- Name
message
- Type
- string
- Description
Message of the response
- Name
messageCode
- Type
- string
- Description
Message code of the response
- Name
result
- Type
- object
- Description
Result of the response
- Name
id
- Type
- string
- Description
Id of the category
- Name
name
- Type
- string
- Description
Name of the category
- Name
recordId
- Type
- string
- Description
Id of the Product in Brand Record
- Name
stockCode
- Type
- string
- Description
Unique id of the stock
- Name
barcode
- Type
- string
- Description
Unique value for each product
- Name
fullName
- Type
- string
- Description
Full name of the product
- Name
seoName
- Type
- string
- Description
SEO Name
- Name
metaTitle
- Type
- string
- Description
MetaTitle associated with the product
- Name
metaDescription
- Type
- string
- Description
MetaDescription associated with the product
- Name
canonicalTags
- Type
- string
- Description
Cannonical Tags associated with the product
- Name
metaKeywords
- Type
- string
- Description
MetaKeywords associated with the product
- Name
link
- Type
- string
- Description
Link of the product
- Name
shortDescription
- Type
- string
- Description
Short description of the product
- Name
description
- Type
- string
- Description
The description for the product.
- Name
brand
- Type
- string
- Description
Name of the brand
- Name
brandLogo
- Type
- string
- Description
Logo of the brand
- Name
subBrand
- Type
- string
- Description
SubBrand of parent Brand
- Name
minPrice
- Type
- number
- Description
Minimum price of the product
- Name
maxPrice
- Type
- number
- Description
Maximum price of the product
- Name
maxPriceWithoutTax
- Type
- number
- Description
Maximum price of the product without tax
- Name
currencyDecimalSeparator
- Type
- number
- Description
Property to separate decimal from the currency
- Name
formatted
- Type
- string
- Description
Contains the list of Price attributes of the product
- Name
withTax
- Type
- number
- Description
Price with tax
- Name
withoutTax
- Type
- number
- Description
Price without tax
- Name
tax
- Type
- number
- Description
Tax to be included in the price
- Name
raw
- Type
- number
- Description
Price of the product without any taxes
- Name
sellPrice
- Type
- number
- Description
Price of the product to be sold
- Name
imageTypes
- Type
- number
- Description
Image types as integer
- Name
tag
- Type
- string
- Description
Tag associated with the Product
- Name
url
- Type
- string
- Description
URL of the Image
- Name
mobileUrl
- Type
- string
- Description
URL for mobile
- Name
alt
- Type
- string
- Description
Alternate text to be added in Image
- Name
link
- Type
- string
- Description
Link of the product
- Name
description
- Type
- string
- Description
Description of the product
- Name
subTitle
- Type
- string
- Description
Subtitle of the Category
- Name
linkType
- Type
- string
- Description
Name of the Logo Image
- Name
buttonText
- Type
- string
- Description
Text to be added in button
- Name
eventCategory
- Type
- string
- Description
Category of the event
- Name
eventAction
- Type
- string
- Description
Action of the event
- Name
gaValue
- Type
- string
- Description
Value of the GA data
- Name
isActive
- Type
- string
- Description
Flag to check the Active status
- Name
displayOrder
- Type
- number
- Description
Order of the display associated with the product
- Name
imageTags
- Type
- array
- Description
Tags associated with each Image
- Name
video
- Type
- array
- Description
Videos associated with each product
- Name
pdfs
- Type
- array
- Description
Pdfs associated with each product
- Name
availability
- Type
- number
- Description
Availability count of the product
- Name
seoAvailability
- Type
- string
- Description
Defines Is Seo available with the Product
- Name
fulfillFromStore
- Type
- boolean
- Description
Flag to check is fulfilFromStore or not
- Name
fulfillFromSupplier
- Type
- boolean
- Description
Flag to check is fulfilFromSupplier or not
- Name
deliveryMessage
- Type
- string
- Description
Message for the delivery
- Name
stockAvailabilityMessage
- Type
- string
- Description
Message to check stock availability
- Name
fulfillFromSupplierDays
- Type
- number
- Description
Number of days for the product to reach the customer from the supplier
- Name
fulfillFromWarehouseDays
- Type
- number
- Description
Number of days for the product to reach the supplier from the warehouse
- Name
currentStock
- Type
- number
- Description
Value of the current stock of particular product
- Name
rating
- Type
- number
- Description
Value of the rating of the particular product
- Name
displayTemplate
- Type
- string
- Description
Template for display of attribute
- Name
isDiscontinued
- Type
- boolean
- Description
Flag to check is discontinued or not
- Name
isVisible
- Type
- boolean
- Description
Flag to check is visible enabled or not
- Name
breadCrumbs
- Type
- array
- Description
Array to sort in the List.
- Name
slugType
- Type
- string
- Description
Describes the type of slug.
- Name
slug
- Type
- string
- Description
Link associated with each Collection
- Name
categoryCode
- Type
- string
- Description
Category Code
- Name
category
- Type
- string
- Description
Category of the product
- Name
itemType
- Type
- string
- Description
Type of the item
- Name
itemTypeCode
- Type
- string
- Description
Code for the itemType
- Name
attributeSetId
- Type
- string
- Description
Id for each of the attributes
- Name
mainCategoryId
- Type
- string
- Description
Main category Id
- Name
mainCategoryName
- Type
- string
- Description
Main category name
- Name
isGiftWrapApplied
- Type
- boolean
- Description
Flag to check if gift wrap applied or not
- Name
giftWrapConfig
- Type
- string
- Description
Configuration of the gift wrap
- Name
promotions
- Type
- array
- Description
Array containing attributes for promotions
- Name
promoCode
- Type
- string
- Description
Unique promo Code for each promotion.
- Name
collections
- Type
- array
- Description
Array containing attributes for collections
- Name
colectionId
- Type
- string
- Description
Collection Id
- Name
flags
- Type
- object
- Description
An Object that stores the Flags to be set
- Name
sellWithoutInventory
- Type
- boolean
- Description
Flag to check if sellWithoutInventory flag is true or false
- Name
isFreeDelivery
- Type
- boolean
- Description
Flag to check is delivery free or not
- Name
preOrder
- Type
- array
- Description
Array containing attributes for order
- Name
isEnabled
- Type
- boolean
- Description
Flag to check Is order enabled or not
- Name
launchDateTime
- Type
- string
- Description
Launch & date time of the order
- Name
customAttributes
- Type
- array
- Description
Array containing list of attributes for the particular product
- Name
customkey
- Type
- string
- Description
custom key of the brand
- Name
isVariantAttribute
- Type
- boolean
- Description
Flag to check is attribute, variant attribute of the product or not
- Name
displayInProductList
- Type
- boolean
- Description
Flag to check display in product list
- Name
displayInProductDetails
- Type
- boolean
- Description
Flag to check display in product details
- Name
groupDisplayOrder
- Type
- number
- Description
Order of the group display
- Name
fieldName
- Type
- string
- Description
Name of the field
- Name
fieldCode
- Type
- string
- Description
Unique Code corresponding to the field
- Name
fieldLabel
- Type
- string
- Description
Label of the field
- Name
inputType
- Type
- string
- Description
Defines the Input type of the attribute
- Name
fieldValues
- Type
- string
- Description
Contains value of the field
- Name
fieldValue
- Type
- number
- Description
Unique code of the Field
- Name
independentProductUrl
- Type
- string
- Description
Independent product URL
- Name
displayInProductWidget
- Type
- boolean
- Description
Display in product widget
- Name
variantProducts
- Type
- array
- Description
Array of objects containing variant products for each variant
- Name
productId
- Type
- string
- Description
Unique id of the Product
- Name
isDefault
- Type
- boolean
- Description
Flag to check is brand by default selected or not
- Name
tax
- Type
- number
- Description
Tax to be included in the price
- Name
isPreOrderEnabled
- Type
- boolean
- Description
Flag to check is preOrder enabled or not
- Name
reviews
- Type
- object
- Description
Object containing list of reviews
- Name
relatedProducts
- Type
- array
- Description
Array of objects containing related products
- Name
relatedTypeCode
- Type
- string
- Description
Defines the group to which related products belong
- Name
hasVariant
- Type
- boolean
- Description
Flag to check Is variant available or not
- Name
sku
- Type
- string
- Description
Defines the group to which related products belong
- Name
freeProducts
- Type
- array
- Description
Array containing information about Free products
- Name
subscriptionEnabled
- Type
- boolean
- Description
Flag to check is subscription enabled or not
- Name
subscriptionPlanType
- Type
- string
- Description
Type of the subscription plan
- Name
componentProducts
- Type
- object
- Description
List of products included as components
- Name
soldIndependently
- Type
- boolean
- Description
Flag to check if product can be sold independently or not
- Name
componentsInStock
- Type
- boolean
- Description
Flag to check if components are in stock or not
- Name
displayInBasket
- Type
- boolean
- Description
Flag to check if displayInBasket true or not
Request
curl --location --request GET 'https://api20.bettercommerce.io/api/v2/catalog/product/265badde-ee82-401a-95a7-ad5e0048ca58' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'
Response
{
"statusCode": 200,
"status": "OK",
"errors": [],
"success": true,
"message": null,
"messageCode": null,
"result": {
"id": "5642869781",
"recordId": "265badde-ee82-401a-95a7-ad5e0048ca58",
"productCode": "BS20560",
"stockCode": "BS20560-BLACK-ONESIZE",
"barcode": "056428378834",
"name": "Black Poncho Jumper with Camel & Cream Stripes",
"fullName": "My Brand Black Poncho Jumper with Camel & Cream Stripes",
"seoName": "",
"metaTitle": "",
"metaDescription": "",
"metaKeywords": "",
"canonicalTags": "",
"link": "products/my-brand-black-poncho-jumper-with-camel-cream-stripes-bs20560-black-onesize",
"shortDescription": "",
"description": "<p>A must-have for the winter season, our Black Poncho Jumper is the perfect hybrid of an oversized super soft jumper and a stylish poncho cape. Plush stripes in black and cream add a bit of something different. Keep it chilled and wear over leggings or pair with black skinnies and heels for a sophisticated autumn/winter outfit. Also available in camel.</p>\n\n<p><strong>DETAILS</strong></p>\n\n<ul>\n\t<li><strong>Poncho Style Jumper</strong></li>\n\t<li><strong>Plush Stripes</strong></li>\n\t<li><strong>High Neck</strong></li>\n\t<li><strong>Elasticated Sleeves</strong></li>\n</ul>\n\n<p><strong>SIZE & FIT</strong></p>\n\n<p>Seema wears ONE SIZE (Approx UK 6-16 dependant on desired fit)</p>\n\n<p>Model height 5'3"</p>\n\n<p><strong>LOOK AFTER ME</strong></p>\n\n<p>Machine wash on cool</p>\n\n<p>Do not bleach</p>\n\n<p>Cool iron on reverse</p>\n\n<p>Do not tumbel dry</p>\n\n<p>Do not dry clean</p>\n\n<p><strong>MATERIAL</strong></p>\n\n<p>55% Viscose 27% Acrylic 18% Nylon</p>\n ",
"notes": "",
"brand": "My Brand",
"brandLogo": "https://liveocxstorage.blob.core.windows.net/betterstore/logo/mybrand.png",
"brandId": 9664,
"brandRecordId": "fcf551c5-ccb5-4214-9b2b-ad5e003dc1a1",
"subBrand": "",
"subBrandId": "0",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£59.99",
"withoutTax": "£59.99",
"tax": "£39.99"
},
"raw": {
"withTax": 59.99,
"withoutTax": 59.99,
"tax": 39.99
}
},
"price": {
"minPrice": 20,
"minPriceWithoutTax": 20,
"maxPrice": 20,
"maxPriceWithoutTax": 20,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£20.00",
"withoutTax": "£20.00",
"tax": "£0.00"
},
"raw": {
"withTax": 20,
"withoutTax": 20,
"tax": 0
}
},
"attributeSet": null,
"uom": "",
"uomValue": "0",
"dimensions": null,
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex20560_black_5092.webp?fm=webp",
"images": [
{
"name": "Image1",
"tag": "Black Poncho Jumper with Camel & Cream Stripes",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex20560_black_5092.webp?fm=webp",
"imageTypes": null,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/ex20560_black_5092.webp?fm=webp",
"mobileUrl": null,
"alt": null,
"link": null,
"description": null,
"subTitle": null,
"linkType": null,
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": false,
"cssClass": null,
"title": null,
"displayOrder": 0,
"imageTags": []
}
],
"videos": null,
"pdFs": null,
"availability": 0,
"seoAvailability": null,
"deliveryMessage": null,
"stockAvailabilityMessage": null,
"fulfilFromWarehouse": false,
"fulfilFromStore": false,
"fulfilFromSupplier": false,
"fulfilFromWarehouseDays": 0,
"fulfilFromSupplierDays": 0,
"fulfilFromInstoreDays": 0,
"currentStock": 236,
"rating": 0,
"displayTemplate": "",
"isDiscontinued": false,
"isVisible": true,
"breadCrumbs": [
{
"slugType": "Manufacturer",
"slug": {
"title": "My Brand",
"slug": "my-brand-url",
"childSlug": null
}
}
],
"classification": {
"categoryCode": "be4e4a38-e2f7-45cb-b586-4c65664d271c",
"category": "PONCHOS",
"itemTypeCode": null,
"itemType": "1",
"attributeSet": "Default Attribute set",
"attributeSetId": "227edf33-1894-43fe-acba-13c795c5c564",
"mainCategoryId": "6e3252f0-b8d5-473e-8b1f-60b62d82b5d5",
"mainCategoryName": "KNITWEAR"
},
"isGiftWrapApplied": false,
"giftWrapConfig": null,
"promotions": [
{
"promoCode": "CATSALE",
"name": "Category Sale"
}
],
"collections": [
{
"collectionId": "e0ba87ad-f8b6-4c01-9c37-ae1b00bb005f",
"name": "Trending Now"
}
],
"flags": {
"sellWithoutInventory": false,
"isFreeDelivery": false
},
"preOrder": {
"shortMessage": "",
"message": "",
"currentStock": 0,
"maxStock": 0,
"isEnabled": false,
"launchDateTime": "1900-01-01T00:00:00"
},
"couponProvider": null,
"customAttributes": [
{
"key": "global.colour",
"customkey": "global.colour~#000000~Colour",
"display": "Colour",
"value": "#000000",
"originalValue": null,
"isVariantAttribute": true,
"displayInProductDetail": true,
"displayInProductList": false,
"groupDisplayOrder": 0
}
],
"variantAttributes": [
{
"fieldName": "Size",
"fieldCode": "clothing.size",
"fieldLabel": null,
"inputType": null,
"fieldValues": [
{
"fieldValue": "onesize",
"fieldLabel": ""
}
],
"independentProductUrl": false,
"displayInProductDetail": true,
"displayInProductWidget": true
}
],
"variantProducts": [
{
"stockCode": "BS20560-BLACK-ONESIZE",
"productId": "265badde-ee82-401a-95a7-ad5e0048ca58",
"slug": "products/my-brand-black-poncho-jumper-with-camel-cream-stripes-bs20560-black-onesize",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex20560_black_5092.webp?fm=webp",
"productName": "Black Poncho Jumper with Camel & Cream Stripes",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£59.99",
"withoutTax": "£59.99",
"tax": "£39.99"
},
"raw": {
"withTax": 59.99,
"withoutTax": 59.99,
"tax": 39.99
}
},
"price": {
"minPrice": 20,
"minPriceWithoutTax": 20,
"maxPrice": 20,
"maxPriceWithoutTax": 20,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£20.00",
"withoutTax": "£20.00",
"tax": "£0.00"
},
"raw": {
"withTax": 20,
"withoutTax": 20,
"tax": 0
}
},
"isDefault": false,
"isPreOrderEnabled": false,
"sellWithoutInventory": false,
"currentStock": 236,
"description": null,
"attributes": [
{
"fieldCode": "clothing.size",
"fieldName": "Size",
"fieldValue": "onesize",
"fieldLabel": ""
},
{
"fieldCode": "global.colour",
"fieldName": "Colour",
"fieldValue": "#000000",
"fieldLabel": ""
}
]
}
],
"reviews": null,
"relatedProducts": [
{
"productId": "11cc48f2-23eb-4579-8836-383a61ad2ea3",
"name": "Personalization",
"stockCode": "ADDON",
"relatedTypeCode": "ADDONS",
"relationDirectionCode": null,
"images": [
{
"name": "Image1",
"tag": null,
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/addon.jfif?fm=webp",
"imageTypes": null,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/products/addon.jfif?fm=webp",
"mobileUrl": null,
"alt": null,
"link": null,
"description": null,
"subTitle": null,
"linkType": null,
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": false,
"cssClass": null,
"title": null,
"displayOrder": 0,
"imageTags": []
}
],
"shortDescription": "<p>This is an add-on product for personalization.</p>\n",
"description": "<p>This is an add-on product for personalization.</p>\n",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/addon.jfif?fm=webp",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£0.00",
"withoutTax": "£0.00",
"tax": "£-1.99"
},
"raw": {
"withTax": 0,
"withoutTax": 0,
"tax": -1.99
}
},
"price": {
"minPrice": 1.99,
"minPriceWithoutTax": 1.99,
"maxPrice": 1.99,
"maxPriceWithoutTax": 1.99,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£1.99",
"withoutTax": "£1.99",
"tax": "£0.00"
},
"raw": {
"withTax": 1.99,
"withoutTax": 1.99,
"tax": 0
}
},
"slug": "products/my-brand-personalization-addon",
"currentStock": 9992,
"brand": "My Brand",
"subBrand": "",
"hasVariant": false,
"itemType": 10,
"sku": "ADDON"
}
],
"freeProducts": [],
"subscriptionEnabled": false,
"subscriptionPlanType": 0,
"componentProducts": null,
"soldIndependently": true,
"componentsInStock": false,
"displayInBasket": false
}
}
Get related products for a specific product
This endpoint retrieves a List of related products based on the Id passed.
Developers - API Operations:
Operation | Endpoint | Response |
---|---|---|
Related products for a specific product | /api/v2/catalog/product/:id/related-products | OK - Related Products |
Required attributes
- Name
id
- Type
- string
- Description
Unique id for each Product.
Response attributes
- Name
statusCode
- Type
- number
- Description
Status code of the response
- Name
status
- Type
- string
- Description
Status of the response
- Name
errors
- Type
- array
- Description
List of errors in the response
- Name
success
- Type
- boolean
- Description
Success status of the response
- Name
message
- Type
- string
- Description
Message of the response
- Name
messageCode
- Type
- string
- Description
Message code of the response
- Name
result
- Type
- object
- Description
Result of the response
- Name
id
- Type
- string
- Description
Id of the category
- Name
name
- Type
- string
- Description
Name of the category
- Name
recordId
- Type
- string
- Description
Id of the Product in Brand Record
- Name
stockCode
- Type
- string
- Description
Unique id of the stock
- Name
barcode
- Type
- string
- Description
Unique value for each product
- Name
isFeatured
- Type
- boolean
- Description
Flag to check is category featured or not
- Name
variant
- Type
- string
- Description
variant name
- Name
variantType
- Type
- string
- Description
variant Type Name
- Name
independentProductUrl
- Type
- string
- Description
Independent product URL
- Name
displayInProductWidget
- Type
- boolean
- Description
Display in product widget
- Name
relatedProducts
- Type
- array
- Description
Array of objects containing related products
- Name
relatedTypeCode
- Type
- string
- Description
Defines the group to which related products belong
- Name
image
- Type
- string
- Description
URL of the Image of the product
- Name
images
- Type
- array
- Description
Array containing the list of Images
- Name
currentStock
- Type
- number
- Description
Value of the current stock of particular product
- Name
brand
- Type
- string
- Description
Name of the brand
- Name
subBrand
- Type
- string
- Description
SubBrand of parent Brand
- Name
hasVariant
- Type
- boolean
- Description
Flag to check Is variant available or not
- Name
itemType
- Type
- string
- Description
Type of the item
- Name
metaTitle
- Type
- string
- Description
MetaTitle associated with the product
- Name
metaDescription
- Type
- string
- Description
MetaDescription associated with the product
- Name
canonicalTags
- Type
- string
- Description
Cannonical Tags associated with the product
- Name
metaKeywords
- Type
- string
- Description
MetaKeywords associated with the product
- Name
flags
- Type
- object
- Description
An Object that stores the Flags to be set
- Name
sellWithoutInventory
- Type
- boolean
- Description
Flag to check if sellWithoutInventory flag is true or false
- Name
isFreeDelivery
- Type
- boolean
- Description
Flag to check is delivery free or not
- Name
isDiscontinued
- Type
- boolean
- Description
Flag to check is discontinued or not
- Name
freeProducts
- Type
- array
- Description
Array containing information about Free products
- Name
variantProducts
- Type
- array
- Description
Array of objects containing variant products for each variant
- Name
minPrice
- Type
- number
- Description
Minimum price of the product
- Name
maxPrice
- Type
- number
- Description
Maximum price of the product
- Name
maxPriceWithoutTax
- Type
- number
- Description
Maximum price of the product without tax
- Name
currencyDecimalSeparator
- Type
- number
- Description
Property to separate decimal from the currency
- Name
formatted
- Type
- string
- Description
Contains the list of Price attributes of the product
- Name
withTax
- Type
- number
- Description
Price with tax
- Name
withoutTax
- Type
- number
- Description
Price without tax
- Name
tax
- Type
- number
- Description
Tax to be included in the price
- Name
raw
- Type
- number
- Description
Price of the product without any taxes
- Name
sellPrice
- Type
- number
- Description
Price of the product to be sold
- Name
imageTypes
- Type
- number
- Description
Image types as integer
- Name
tag
- Type
- string
- Description
Tag associated with the Product
- Name
url
- Type
- string
- Description
URL of the Image
- Name
mobileUrl
- Type
- string
- Description
URL for mobile
- Name
alt
- Type
- string
- Description
Alternate text to be added in Image
- Name
link
- Type
- string
- Description
Link of the product
- Name
description
- Type
- string
- Description
Description of the product
- Name
subTitle
- Type
- string
- Description
Subtitle of the Category
- Name
linkType
- Type
- string
- Description
Name of the Logo Image
- Name
buttonText
- Type
- string
- Description
Text to be added in button
- Name
eventCategory
- Type
- string
- Description
Category of the event
- Name
eventAction
- Type
- string
- Description
Action of the event
- Name
gaValue
- Type
- string
- Description
Value of the GA data
- Name
isActive
- Type
- string
- Description
Flag to check the Active status
- Name
displayOrder
- Type
- number
- Description
Order of the display associated with the product
- Name
mainCategoryId
- Type
- string
- Description
Main category Id
- Name
mainCategoryName
- Type
- string
- Description
Main category name
- Name
attributeSetId
- Type
- string
- Description
Id for each of the attributes
- Name
fulfillFromStore
- Type
- boolean
- Description
Flag to check is fulfilFromStore or not
- Name
fulfillFromSupplier
- Type
- boolean
- Description
Flag to check is fulfilFromSupplier or not
- Name
deliveryMessage
- Type
- string
- Description
Message for the delivery
- Name
stockAvailabilityMessage
- Type
- string
- Description
Message to check stock availability
- Name
trending
- Type
- boolean
- Description
Is Product trending or not
- Name
bestSeller
- Type
- boolean
- Description
Is Product bestSeller or not
- Name
onSale
- Type
- boolean
- Description
Is Product onSale or not
- Name
newLaunch
- Type
- boolean
- Description
Is Product newly launched or not
- Name
exclusive
- Type
- boolean
- Description
Is Product exclusiv or not
- Name
extendedDescription
- Type
- string
- Description
Extended description of the product
- Name
variantProductsMinimal
- Type
- array
- Description
Minimal variant products array
- Name
isMasterStock
- Type
- boolean
- Description
Flag to check Is master stock or not
- Name
hasVariant
- Type
- boolean
- Description
Flag to check Is variant available or not
- Name
promotions
- Type
- array
- Description
Array containing attributes for promotions
- Name
preOrder
- Type
- array
- Description
Array containing attributes for order
- Name
isEnabled
- Type
- boolean
- Description
Flag to check Is order enabled or not
- Name
launchDateTime
- Type
- string
- Description
Launch & date time of the order
Request
curl --location --request GET 'https://api20.bettercommerce.io/api/v2/catalog/product/265badde-ee82-401a-95a7-ad5e0048ca58/related-products' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'
Response
{
"statusCode": 200,
"status": "OK",
"errors": [],
"success": true,
"message": null,
"messageCode": null,
"result": [
{
"id": "5642870579",
"seoName": "",
"barcode": null,
"isFeatured": false,
"uom": null,
"uomValue": 0,
"variant": {
"variantInputType": 0,
"listType": 0,
"independentProductUrl": false,
"displayInProductWidget": false,
"displayInProductDetail": false,
"attributes": null,
"variantInputTypes": null
},
"attributeSet": null,
"relatedProducts": [
{
"productId": "11cc48f2-23eb-4579-8836-383a61ad2ea3",
"name": "ADDON",
"stockCode": "ADDON",
"relatedTypeCode": "ADDONS",
"relationDirectionCode": null,
"images": null,
"shortDescription": null,
"description": null,
"image": null,
"listPrice": null,
"price": null,
"slug": null,
"currentStock": 0,
"brand": null,
"subBrand": null,
"hasVariant": false,
"itemType": 0,
"sku": null
}
],
"displayOrder": 0,
"metaTitle": "",
"metaDescription": "",
"metaKeywords": null,
"canonicalTags": null,
"flags": {
"isFreeDelivery": false,
"sellWithoutInventory": false
},
"isDiscontinued": false,
"freeProducts": [],
"link": null,
"componentProducts": null,
"componentsInStock": false,
"variantProducts": null,
"variantProductsAttribute": null,
"subscriptionEnabled": false,
"minPrice": null,
"maxPrice": null,
"displayTemplate": "",
"brandLogo": "https://liveocxstorage.blob.core.windows.net/betterstore/logo/mybrand.png",
"attributes": [
{
"key": "Personalisation.enable",
"customkey": "Personalisation.enable~true~Is Enabled",
"display": "Is Enabled",
"value": "true",
"originalValue": null,
"isVariantAttribute": false,
"displayInProductDetail": false,
"displayInProductList": false,
"groupDisplayOrder": 0
}
],
"recordId": "11cc48f2-23eb-4579-8836-383a61ad2ea3",
"name": "Personalization",
"slug": "products/my-brand-personalization-addon",
"stockCode": "ADDON",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£0.00",
"withoutTax": "£0.00",
"tax": "£-1.99"
},
"raw": {
"withTax": 0,
"withoutTax": 0,
"tax": -1.99
}
},
"price": {
"minPrice": 1.99,
"minPriceWithoutTax": 1.99,
"maxPrice": 1.99,
"maxPriceWithoutTax": 1.99,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£1.99",
"withoutTax": "£1.99",
"tax": "£0.00"
},
"raw": {
"withTax": 1.99,
"withoutTax": 1.99,
"tax": 0
}
},
"images": [
{
"name": "Image1",
"tag": null,
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/addon.jfif?fm=webp",
"imageTypes": null,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/products/addon.jfif?fm=webp",
"mobileUrl": null,
"alt": null,
"link": null,
"description": null,
"subTitle": null,
"linkType": null,
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": false,
"cssClass": null,
"title": null,
"displayOrder": 0,
"imageTags": []
}
],
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/addon.jfif?fm=webp",
"itemType": 10,
"shortDescription": "<p>This is an add-on product for personalization.</p>\n",
"subscriptionPlanType": 0,
"groupName": null,
"brand": "My Brand",
"brandSlug": null,
"subBrand": "",
"sku": "ADDON",
"priceFrom": {
"minPrice": 1.99,
"minPriceWithoutTax": 1.99,
"maxPrice": 1.99,
"maxPriceWithoutTax": 1.99,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£1.99",
"withoutTax": "£1.99",
"tax": "£0.00"
},
"raw": {
"withTax": 1.99,
"withoutTax": 1.99,
"tax": 0
}
},
"classification": {
"categoryId": "ac121b0e-fce1-4306-b4f9-6d342283a728",
"categoryCode": "ac121b0e-fce1-4306-b4f9-6d342283a728",
"mainCategoryId": "ac121b0e-fce1-4306-b4f9-6d342283a728",
"mainCategoryName": "COATS",
"category": "COATS",
"itemTypeCode": null,
"itemType": "10",
"attributeSet": "Personalisation",
"attributeSetId": "1c860d99-30cd-407d-8e89-21723f8b91bc"
},
"currentStock": 9992,
"description": "<p>This is an add-on product for personalization.</p>\n",
"fulfilFromWarehouse": true,
"fulfilFromStore": false,
"fulfilFromSupplier": false,
"deliveryMessage": null,
"stockAvailabilityMessage": null,
"trending": false,
"bestSeller": false,
"onSale": false,
"newLaunch": false,
"exclusive": false,
"extendedDescription": null,
"variantProductsMinimal": null,
"variantProductsAttributeMinimal": null,
"isVisible": true,
"isActive": true,
"isMasterStock": true,
"hasVariant": false,
"promotions": null,
"preOrder": {
"isEnabled": false,
"launchDateTime": "1900-01-01T00:00:00"
}
}
]
}
Post product review
This endpoint enables the user to post a product review.
Developers - API Operations:
Operation | Endpoint | Response |
---|---|---|
Post Product review | /api/v2/catalog/product/:id/review | OK- Post product review |
Required attributes
- Name
id
- Type
- string
- Description
Product GUID identifier
Model attributes
- Name
title
- Type
- string
- Description
Title of the review.
- Name
rating
- Type
- number
- Description
Rating by the user.
- Name
comment
- Type
- string
- Description
Comment by the customer for the review.
- Name
isRecommended
- Type
- boolean
- Description
Flag to check if isRecommended true or not
- Name
reviewSections
- Type
- array
- Description
Array containing various review section attributes
- Name
sectionName
- Type
- string
- Description
Title of the section added
- Name
userId
- Type
- string
- Description
Unique Id generated for every user
- Name
remainAnonymous
- Type
- boolean
- Description
Flag to check if customer wants to remain anonymous or not
- Name
nickname
- Type
- string
- Description
Contains a nickname, the customer added
- Name
location
- Type
- string
- Description
Contains a location, the customer added
- Name
age
- Type
- number
- Description
Contains the age of the customer
- Name
gender
- Type
- string
- Description
Contains the gender of the customer
- Name
userEmail
- Type
- string
- Description
Contains the userEmail of the customer
Response attributes
- Name
statusCode
- Type
- number
- Description
Status code of the response
- Name
status
- Type
- string
- Description
Status of the response
- Name
errors
- Type
- array
- Description
List of errors in the response
- Name
success
- Type
- boolean
- Description
Success status of the response
- Name
message
- Type
- string
- Description
Message of the response
- Name
messageCode
- Type
- string
- Description
Message code of the response
- Name
result
- Type
- object
- Description
Result of the response
- Name
recordId
- Type
- string
- Description
Unique Id of the Product in Brand Record
- Name
id
- Type
- string
- Description
Product GUID identifier
- Name
isValid
- Type
- boolean
- Description
Flag to check if review Valid or not.
Request
curl --location --request POST 'https://api20.bettercommerce.io/api/v2/catalog/product/265badde-ee82-401a-95a7-ad5e0048ca58/review' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597' \
--data-urlencode 'title=lovely product' \
--data-urlencode 'rating=5' \
--data-urlencode 'comment=Its been great to buy from merchant X. the item is fantastic' \
--data-urlencode 'isRecommended=true' \
--data-urlencode 'reviewSections={"sectionName":"dolor Excepteur D","options":[{"value":"<Error: Too many levels of nesting to fake this schema>"},{"value":"<Error: Too many levels of nesting to fake this schema>"}]}' \
--data-urlencode 'reviewSections={"sectionName":"est occaecat","options":[{"value":"<Error: Too many levels of nesting to fake this schema>"},{"value":"<Error: Too many levels of nesting to fake this schema>"}]}' \
--data-urlencode 'userId=' \
--data-urlencode 'remainAnonymous=false' \
--data-urlencode 'nickname=Jack' \
--data-urlencode 'location=London' \
--data-urlencode 'age=34' \
--data-urlencode 'gender=M' \
--data-urlencode 'userEmail=xyv@xyz.com'
Response
{
"statusCode": 401,
"status": "ad dolore",
"errors": [
"magna anim sint nisi",
"aute laboris ipsum enim"
],
"success": false,
"message": "incididunt consectetur Ut",
"messageCode": "deserunt minim",
"result": {
"recordId": "00000000-0000-0000-0000-000000000000",
"id": 74059206,
"isValid": false
}
}
Notify Me
This endpoint enables the user to be notified.
Developers - API Operations:
Operation | Endpoint | Response |
---|---|---|
Notify me | /api/v2/catalog/product/:id/notifyme?email={{email}} | OK - Notification Saved |
Required attributes
- Name
id
- Type
- string
- Description
Unique identifier for the customer.
- Name
email
- Type
- string
- Description
Email id of the customer.
Response attributes
- Name
statusCode
- Type
- number
- Description
Status code of the response
- Name
status
- Type
- string
- Description
Status of the response
- Name
errors
- Type
- array
- Description
List of errors in the response
- Name
success
- Type
- boolean
- Description
Success status of the response
- Name
message
- Type
- string
- Description
Message of the response
- Name
messageCode
- Type
- string
- Description
Message code of the response
- Name
result
- Type
- object
- Description
Result of the response
- Name
recordId
- Type
- string
- Description
Unique Id of the Product in Brand Record
- Name
id
- Type
- string
- Description
Id of the category
- Name
name
- Type
- string
- Description
Name of the category
- Name
recordId
- Type
- string
- Description
Id of the Product in Brand Record
- Name
stockCode
- Type
- string
- Description
Unique id of the stock
- Name
barcode
- Type
- string
- Description
Unique value for each product
- Name
fullName
- Type
- string
- Description
Full name of the product
- Name
seoName
- Type
- string
- Description
SEO Name
- Name
metaTitle
- Type
- string
- Description
MetaTitle associated with the product
- Name
metaDescription
- Type
- string
- Description
MetaDescription associated with the product
- Name
canonicalTags
- Type
- string
- Description
Cannonical Tags associated with the product
- Name
metaKeywords
- Type
- string
- Description
MetaKeywords associated with the product
- Name
link
- Type
- string
- Description
Link of the product
- Name
shortDescription
- Type
- string
- Description
Short description of the product
- Name
description
- Type
- string
- Description
The description for the product.
- Name
brand
- Type
- string
- Description
Name of the brand
- Name
brandLogo
- Type
- string
- Description
Logo of the brand
- Name
subBrand
- Type
- string
- Description
SubBrand of parent Brand
- Name
minPrice
- Type
- number
- Description
Minimum price of the product
- Name
maxPrice
- Type
- number
- Description
Maximum price of the product
- Name
maxPriceWithoutTax
- Type
- number
- Description
Maximum price of the product without tax
- Name
currencyDecimalSeparator
- Type
- number
- Description
Property to separate decimal from the currency
- Name
formatted
- Type
- string
- Description
Contains the list of Price attributes of the product
- Name
withTax
- Type
- number
- Description
Price with tax
- Name
withoutTax
- Type
- number
- Description
Price without tax
- Name
tax
- Type
- number
- Description
Tax to be included in the price
- Name
raw
- Type
- number
- Description
Price of the product without any taxes
- Name
sellPrice
- Type
- number
- Description
Price of the product to be sold
- Name
imageTypes
- Type
- number
- Description
Image types as integer
- Name
tag
- Type
- string
- Description
Tag associated with the Product
- Name
url
- Type
- string
- Description
URL of the Image
- Name
mobileUrl
- Type
- string
- Description
URL for mobile
- Name
alt
- Type
- string
- Description
Alternate text to be added in Image
- Name
link
- Type
- string
- Description
Link of the product
- Name
description
- Type
- string
- Description
Description of the product
- Name
subTitle
- Type
- string
- Description
Subtitle of the Category
- Name
linkType
- Type
- string
- Description
Name of the Logo Image
- Name
buttonText
- Type
- string
- Description
Text to be added in button
- Name
eventCategory
- Type
- string
- Description
Category of the event
- Name
eventAction
- Type
- string
- Description
Action of the event
- Name
gaValue
- Type
- string
- Description
Value of the GA data
- Name
isActive
- Type
- string
- Description
Flag to check the Active status
- Name
displayOrder
- Type
- number
- Description
Order of the display associated with the product
- Name
imageTags
- Type
- array
- Description
Tags associated with each Image
- Name
video
- Type
- array
- Description
Videos associated with each product
- Name
pdfs
- Type
- array
- Description
Pdfs associated with each product
- Name
availability
- Type
- number
- Description
Availability count of the product
- Name
seoAvailability
- Type
- string
- Description
Defines Is Seo available with the Product
- Name
fulfillFromStore
- Type
- boolean
- Description
Flag to check is fulfilFromStore or not
- Name
fulfillFromSupplier
- Type
- boolean
- Description
Flag to check is fulfilFromSupplier or not
- Name
deliveryMessage
- Type
- string
- Description
Message for the delivery
- Name
stockAvailabilityMessage
- Type
- string
- Description
Message to check stock availability
- Name
fulfillFromSupplierDays
- Type
- number
- Description
Number of days for the product to reach the customer from the supplier
- Name
fulfillFromWarehouseDays
- Type
- number
- Description
Number of days for the product to reach the supplier from the warehouse
- Name
currentStock
- Type
- number
- Description
Value of the current stock of particular product
- Name
rating
- Type
- number
- Description
Value of the rating of the particular product
- Name
displayTemplate
- Type
- string
- Description
Template for display of attribute
- Name
isDiscontinued
- Type
- boolean
- Description
Flag to check is discontinued or not
- Name
isVisible
- Type
- boolean
- Description
Flag to check is visible enabled or not
- Name
breadCrumbs
- Type
- array
- Description
Array to sort in the List.
- Name
slugType
- Type
- string
- Description
Describes the type of slug.
- Name
slug
- Type
- string
- Description
Link associated with each Collection
- Name
categoryCode
- Type
- string
- Description
Category Code
- Name
category
- Type
- string
- Description
Category of the product
- Name
itemType
- Type
- string
- Description
Type of the item
- Name
itemTypeCode
- Type
- string
- Description
Code for the itemType
- Name
attributeSetId
- Type
- string
- Description
Id for each of the attributes
- Name
mainCategoryId
- Type
- string
- Description
Main category Id
- Name
mainCategoryName
- Type
- string
- Description
Main category name
- Name
isGiftWrapApplied
- Type
- boolean
- Description
Flag to check if gift wrap applied or not
- Name
giftWrapConfig
- Type
- string
- Description
Configuration of the gift wrap
- Name
promotions
- Type
- array
- Description
Array containing attributes for promotions
- Name
promoCode
- Type
- string
- Description
Unique promo Code for each promotion.
- Name
collections
- Type
- array
- Description
Array containing attributes for collections
- Name
colectionId
- Type
- string
- Description
Collection Id
- Name
flags
- Type
- object
- Description
An Object that stores the Flags to be set
- Name
sellWithoutInventory
- Type
- boolean
- Description
Flag to check if sellWithoutInventory flag is true or false
- Name
isFreeDelivery
- Type
- boolean
- Description
Flag to check is delivery free or not
- Name
preOrder
- Type
- array
- Description
Array containing attributes for order
- Name
isEnabled
- Type
- boolean
- Description
Flag to check Is order enabled or not
- Name
launchDateTime
- Type
- string
- Description
Launch & date time of the order
- Name
customAttributes
- Type
- array
- Description
Array containing list of attributes for the particular product
- Name
customkey
- Type
- string
- Description
custom key of the brand
- Name
isVariantAttribute
- Type
- boolean
- Description
Flag to check is attribute, variant attribute of the product or not
- Name
displayInProductList
- Type
- boolean
- Description
Flag to check display in product list
- Name
displayInProductDetails
- Type
- boolean
- Description
Flag to check display in product details
- Name
groupDisplayOrder
- Type
- number
- Description
Order of the group display
- Name
fieldName
- Type
- string
- Description
Name of the field
- Name
fieldCode
- Type
- string
- Description
Unique Code corresponding to the field
- Name
fieldLabel
- Type
- string
- Description
Label of the field
- Name
inputType
- Type
- string
- Description
Defines the Input type of the attribute
- Name
fieldValues
- Type
- string
- Description
Contains value of the field
- Name
fieldValue
- Type
- number
- Description
Unique code of the Field
- Name
independentProductUrl
- Type
- string
- Description
Independent product URL
- Name
displayInProductWidget
- Type
- boolean
- Description
Display in product widget
- Name
variantProducts
- Type
- array
- Description
Array of objects containing variant products for each variant
- Name
productId
- Type
- string
- Description
Unique id of the Product
- Name
isDefault
- Type
- boolean
- Description
Flag to check is brand by default selected or not
- Name
tax
- Type
- number
- Description
Tax to be included in the price
- Name
isPreOrderEnabled
- Type
- boolean
- Description
Flag to check is preOrder enabled or not
- Name
reviews
- Type
- object
- Description
Object containing list of reviews
- Name
relatedProducts
- Type
- array
- Description
Array of objects containing related products
- Name
relatedTypeCode
- Type
- string
- Description
Defines the group to which related products belong
- Name
hasVariant
- Type
- boolean
- Description
Flag to check Is variant available or not
- Name
sku
- Type
- string
- Description
Defines the group to which related products belong
- Name
freeProducts
- Type
- array
- Description
Array containing information about Free products
- Name
subscriptionEnabled
- Type
- boolean
- Description
Flag to check is subscription enabled or not
- Name
subscriptionPlanType
- Type
- string
- Description
Type of the subscription plan
- Name
componentProducts
- Type
- object
- Description
List of products included as components
- Name
soldIndependently
- Type
- boolean
- Description
Flag to check if product can be sold independently or not
- Name
componentsInStock
- Type
- boolean
- Description
Flag to check if components are in stock or not
- Name
displayInBasket
- Type
- boolean
- Description
Flag to check if displayInBasket true or not
Request
curl --location -g --request POST 'https://api20.bettercommerce.io/api/v2/catalog/product/265badde-ee82-401a-95a7-ad5e0048ca58/notifyme?email={{bc_notifyme_email}' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'
Response
{
"statusCode": 200,
"status": "OK",
"errors": [],
"success": true,
"message": null,
"messageCode": null,
"result": {
"id": "5642869781",
"recordId": "265badde-ee82-401a-95a7-ad5e0048ca58",
"productCode": "BS20560",
"stockCode": "BS20560-BLACK-ONESIZE",
"barcode": "056428378834",
"name": "Black Poncho Jumper with Camel & Cream Stripes",
"fullName": "My Brand Black Poncho Jumper with Camel & Cream Stripes",
"seoName": "",
"metaTitle": "My Brand Black Poncho Jumper with Camel & Cream Stripes | Betterstore",
"metaDescription": "Buy My Brand Black Poncho Jumper with Camel & Cream Stripes online at Betterstore. Next-day delivery is available.",
"metaKeywords": "My Brand Black Poncho Jumper with Camel & Cream Stripes | Betterstore",
"canonicalTags": "",
"link": "products/my-brand-black-poncho-jumper-with-camel-cream-stripes-bs20560-black-onesize",
"shortDescription": "",
"description": "<p>A must-have for the winter season, our Black Poncho Jumper is the perfect hybrid of an oversized super soft jumper and a stylish poncho cape. Plush stripes in black and cream add a bit of something different. Keep it chilled and wear over leggings or pair with black skinnies and heels for a sophisticated autumn/winter outfit. Also available in camel.</p>\n\n<p><strong>DETAILS</strong></p>\n\n<ul>\n\t<li><strong>Poncho Style Jumper</strong></li>\n\t<li><strong>Plush Stripes</strong></li>\n\t<li><strong>High Neck</strong></li>\n\t<li><strong>Elasticated Sleeves</strong></li>\n</ul>\n\n<p><strong>SIZE & FIT</strong></p>\n\n<p>Seema wears ONE SIZE (Approx UK 6-16 dependant on desired fit)</p>\n\n<p>Model height 5'3"</p>\n\n<p><strong>LOOK AFTER ME</strong></p>\n\n<p>Machine wash on cool</p>\n\n<p>Do not bleach</p>\n\n<p>Cool iron on reverse</p>\n\n<p>Do not tumbel dry</p>\n\n<p>Do not dry clean</p>\n\n<p><strong>MATERIAL</strong></p>\n\n<p>55% Viscose 27% Acrylic 18% Nylon</p>\n ",
"notes": "",
"brand": "My Brand",
"brandLogo": "https://liveocxstorage.blob.core.windows.net/betterstore/logo/mybrand.png",
"brandId": 9664,
"brandRecordId": "fcf551c5-ccb5-4214-9b2b-ad5e003dc1a1",
"subBrand": "",
"subBrandId": "0",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£59.99",
"withoutTax": "£59.99",
"tax": "£39.99"
},
"raw": {
"withTax": 59.99,
"withoutTax": 59.99,
"tax": 39.99
}
},
"price": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£20.00",
"withoutTax": "£20.00",
"tax": "£0.00"
},
"raw": {
"withTax": 20,
"withoutTax": 20,
"tax": 0
}
},
"attributeSet": null,
"uom": "",
"uomValue": "0",
"dimensions": null,
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex20560_black_5092.webp?fm=webp",
"images": [
{
"name": "Image1",
"tag": "Black Poncho Jumper with Camel & Cream Stripes",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex20560_black_5092.webp?fm=webp",
"imageTypes": null,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/ex20560_black_5092.webp?fm=webp",
"mobileUrl": null,
"alt": null,
"link": null,
"description": null,
"subTitle": null,
"linkType": null,
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": false,
"cssClass": null,
"title": null,
"displayOrder": 0,
"imageTags": []
}
],
"videos": null,
"pdFs": null,
"availability": 0,
"seoAvailability": null,
"deliveryMessage": null,
"stockAvailabilityMessage": null,
"fulfilFromWarehouse": false,
"fulfilFromStore": false,
"fulfilFromSupplier": false,
"fulfilFromWarehouseDays": 0,
"fulfilFromSupplierDays": 0,
"fulfilFromInstoreDays": 0,
"currentStock": 236,
"rating": 0,
"displayTemplate": "",
"isDiscontinued": false,
"isVisible": true,
"breadCrumbs": [
{
"slugType": "Manufacturer",
"slug": {
"title": "",
"slug": "my-brand-url",
"childSlug": null
}
}
],
"classification": {
"categoryCode": "be4e4a38-e2f7-45cb-b586-4c65664d271c",
"category": "PONCHOS",
"itemTypeCode": null,
"itemType": "1",
"attributeSet": "Default Attribute set",
"attributeSetId": "227edf33-1894-43fe-acba-13c795c5c564",
"mainCategoryId": "6e3252f0-b8d5-473e-8b1f-60b62d82b5d5",
"mainCategoryName": "KNITWEAR"
},
"isGiftWrapApplied": false,
"giftWrapConfig": null,
"promotions": [
{
"promoCode": "CATSALE",
"name": "Category Sale"
}
],
"collections": null,
"flags": {
"sellWithoutInventory": false,
"isFreeDelivery": false
},
"preOrder": {
"shortMessage": "",
"message": "",
"currentStock": 0,
"maxStock": 0,
"isEnabled": false,
"launchDateTime": "1900-01-01T00:00:00"
},
"couponProvider": null,
"customAttributes": [
{
"key": "clothing.size",
"customkey": "clothing.size~onesize~Size",
"display": "Size",
"value": "onesize",
"originalValue": null,
"isVariantAttribute": true,
"displayInProductDetail": true,
"displayInProductList": false,
"groupDisplayOrder": 0
}
],
"variantAttributes": [
{
"fieldName": "Size",
"fieldCode": "clothing.size",
"fieldLabel": null,
"inputType": null,
"fieldValues": [],
"independentProductUrl": false,
"displayInProductDetail": true,
"displayInProductWidget": true
}
],
"variantProducts": [],
"reviews": null,
"relatedProducts": [
{
"productId": "11cc48f2-23eb-4579-8836-383a61ad2ea3",
"name": "Personalization",
"stockCode": "ADDON",
"relatedTypeCode": "ADDONS",
"relationDirectionCode": null,
"images": [
{
"name": "Image1",
"tag": null,
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/addon.jfif?fm=webp",
"imageTypes": null,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/products/addon.jfif?fm=webp",
"mobileUrl": null,
"alt": null,
"link": null,
"description": null,
"subTitle": null,
"linkType": null,
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": false,
"cssClass": null,
"title": null,
"displayOrder": 0,
"imageTags": []
}
],
"shortDescription": "<p>This is an add-on product for personalization.</p>\n",
"description": "<p>This is an add-on product for personalization.</p>\n",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/addon.jfif?fm=webp",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£0.00",
"withoutTax": "£0.00",
"tax": "£-1.99"
},
"raw": {
"withTax": 0,
"withoutTax": 0,
"tax": -1.99
}
},
"price": {
"minPrice": 1.99,
"minPriceWithoutTax": 1.99,
"maxPrice": 1.99,
"maxPriceWithoutTax": 1.99,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£1.99",
"withoutTax": "£1.99",
"tax": "£0.00"
},
"raw": {
"withTax": 1.99,
"withoutTax": 1.99,
"tax": 0
}
},
"slug": "products/my-brand-personalization-addon",
"currentStock": 9992,
"brand": "My Brand",
"subBrand": "",
"hasVariant": false,
"itemType": 10,
"sku": "ADDON"
}
],
"freeProducts": null,
"subscriptionEnabled": false,
"subscriptionPlanType": 0,
"componentProducts": null,
"soldIndependently": true,
"componentsInStock": false,
"displayInBasket": false
}
}
Get Preview product details before product is published
This endpoint retrieves a product by the slug before a product is published.
Developers - API Operations for different responses:
Operation | Endpoint | Response |
---|---|---|
Product preview by slug | /api/v2/catalog/product/preview?slug={{product_preview_slug}} | Get product preview before product is published |
Required attribute
- Name
slug
- Type
- string
- Description
Product slug to retrive details
Response attributes
- Name
statusCode
- Type
- number
- Description
Status code of the response
- Name
status
- Type
- string
- Description
Status of the response
- Name
errors
- Type
- array
- Description
List of errors in the response
- Name
success
- Type
- boolean
- Description
Success status of the response
- Name
message
- Type
- string
- Description
Message of the response
- Name
messageCode
- Type
- string
- Description
Message code of the response
- Name
result
- Type
- object
- Description
Result of the response
- Name
id
- Type
- string
- Description
Id of the category
- Name
name
- Type
- string
- Description
Name of the category
- Name
recordId
- Type
- string
- Description
Id of the Product in Brand Record
- Name
stockCode
- Type
- string
- Description
Unique id of the stock
- Name
barcode
- Type
- string
- Description
Unique value for each product
- Name
fullName
- Type
- string
- Description
Full name of the product
- Name
seoName
- Type
- string
- Description
SEO Name
- Name
metaTitle
- Type
- string
- Description
MetaTitle associated with the product
- Name
metaDescription
- Type
- string
- Description
MetaDescription associated with the product
- Name
canonicalTags
- Type
- string
- Description
Cannonical Tags associated with the product
- Name
metaKeywords
- Type
- string
- Description
MetaKeywords associated with the product
- Name
link
- Type
- string
- Description
Link of the product
- Name
shortDescription
- Type
- string
- Description
Short description of the product
- Name
description
- Type
- string
- Description
The description for the product.
- Name
brand
- Type
- string
- Description
Name of the brand
- Name
brandLogo
- Type
- string
- Description
Logo of the brand
- Name
subBrand
- Type
- string
- Description
SubBrand of parent Brand
- Name
minPrice
- Type
- number
- Description
Minimum price of the product
- Name
maxPrice
- Type
- number
- Description
Maximum price of the product
- Name
maxPriceWithoutTax
- Type
- number
- Description
Maximum price of the product without tax
- Name
currencyDecimalSeparator
- Type
- number
- Description
Property to separate decimal from the currency
- Name
formatted
- Type
- string
- Description
Contains the list of Price attributes of the product
- Name
withTax
- Type
- number
- Description
Price with tax
- Name
withoutTax
- Type
- number
- Description
Price without tax
- Name
tax
- Type
- number
- Description
Tax to be included in the price
- Name
raw
- Type
- number
- Description
Price of the product without any taxes
- Name
sellPrice
- Type
- number
- Description
Price of the product to be sold
- Name
imageTypes
- Type
- number
- Description
Image types as integer
- Name
tag
- Type
- string
- Description
Tag associated with the Product
- Name
url
- Type
- string
- Description
URL of the Image
- Name
mobileUrl
- Type
- string
- Description
URL for mobile
- Name
alt
- Type
- string
- Description
Alternate text to be added in Image
- Name
link
- Type
- string
- Description
Link of the product
- Name
description
- Type
- string
- Description
Description of the product
- Name
subTitle
- Type
- string
- Description
Subtitle of the Category
- Name
linkType
- Type
- string
- Description
Name of the Logo Image
- Name
buttonText
- Type
- string
- Description
Text to be added in button
- Name
eventCategory
- Type
- string
- Description
Category of the event
- Name
eventAction
- Type
- string
- Description
Action of the event
- Name
gaValue
- Type
- string
- Description
Value of the GA data
- Name
isActive
- Type
- string
- Description
Flag to check the Active status
- Name
displayOrder
- Type
- number
- Description
Order of the display associated with the product
- Name
imageTags
- Type
- array
- Description
Tags associated with each Image
- Name
videos
- Type
- array
- Description
Videos associated with each product
- Name
pdfs
- Type
- array
- Description
Pdfs associated with each product
- Name
availability
- Type
- number
- Description
Availability count of the product
- Name
seoAvailability
- Type
- string
- Description
Defines Is Seo available with the Product
- Name
fulfillFromStore
- Type
- boolean
- Description
Flag to check is fulfilFromStore or not
- Name
fulfillFromSupplier
- Type
- boolean
- Description
Flag to check is fulfilFromSupplier or not
- Name
deliveryMessage
- Type
- string
- Description
Message for the delivery
- Name
stockAvailabilityMessage
- Type
- string
- Description
Message to check stock availability
- Name
fulfillFromSupplierDays
- Type
- number
- Description
Number of days for the product to reach the customer from the supplier
- Name
fulfillFromWarehouseDays
- Type
- number
- Description
Number of days for the product to reach the supplier from the warehouse
- Name
currentStock
- Type
- number
- Description
Value of the current stock of particular product
- Name
rating
- Type
- number
- Description
Value of the rating of the particular product
- Name
displayTemplate
- Type
- string
- Description
Template for display of attribute
- Name
isDiscontinued
- Type
- boolean
- Description
Flag to check is discontinued or not
- Name
isVisible
- Type
- boolean
- Description
Flag to check is visible enabled or not
- Name
breadCrumbs
- Type
- array
- Description
Array to sort in the List.
- Name
slugType
- Type
- string
- Description
Describes the type of slug.
- Name
slug
- Type
- string
- Description
Link associated with each Collection
- Name
categoryCode
- Type
- string
- Description
Category Code
- Name
category
- Type
- string
- Description
Category of the product
- Name
itemType
- Type
- string
- Description
Type of the item
- Name
itemTypeCode
- Type
- string
- Description
Code for the itemType
- Name
attributeSetId
- Type
- string
- Description
Id for each of the attributes
- Name
mainCategoryId
- Type
- string
- Description
Main category Id
- Name
mainCategoryName
- Type
- string
- Description
Main category name
- Name
isGiftWrapApplied
- Type
- boolean
- Description
Flag to check if gift wrap applied or not
- Name
giftWrapConfig
- Type
- string
- Description
Configuration of the gift wrap
- Name
promotions
- Type
- array
- Description
Array containing attributes for promotions
- Name
promoCode
- Type
- string
- Description
Unique promo Code for each promotion.
- Name
collections
- Type
- array
- Description
Array containing attributes for collections
- Name
colectionId
- Type
- string
- Description
Collection Id
- Name
flags
- Type
- object
- Description
An Object that stores the Flags to be set
- Name
sellWithoutInventory
- Type
- boolean
- Description
Flag to check if sellWithoutInventory flag is true or false
- Name
isFreeDelivery
- Type
- boolean
- Description
Flag to check is delivery free or not
- Name
preOrder
- Type
- array
- Description
Array containing attributes for order
- Name
isEnabled
- Type
- boolean
- Description
Flag to check Is order enabled or not
- Name
launchDateTime
- Type
- string
- Description
Launch & date time of the order
- Name
customAttributes
- Type
- array
- Description
Array containing list of attributes for the particular product
- Name
customkey
- Type
- string
- Description
custom key of the brand
- Name
isVariantAttribute
- Type
- boolean
- Description
Flag to check is attribute, variant attribute of the product or not
- Name
displayInProductList
- Type
- boolean
- Description
Flag to check display in product list
- Name
displayInProductDetails
- Type
- boolean
- Description
Flag to check display in product details
- Name
groupDisplayOrder
- Type
- number
- Description
Order of the group display
- Name
fieldName
- Type
- string
- Description
Name of the field
- Name
fieldCode
- Type
- string
- Description
Unique Code corresponding to the field
- Name
fieldLabel
- Type
- string
- Description
Label of the field
- Name
inputType
- Type
- string
- Description
Defines the Input type of the attribute
- Name
fieldValues
- Type
- string
- Description
Contains value of the field
- Name
fieldValue
- Type
- number
- Description
Unique code of the Field
- Name
independentProductUrl
- Type
- string
- Description
Independent product URL
- Name
displayInProductWidget
- Type
- boolean
- Description
Display in product widget
- Name
variantProducts
- Type
- array
- Description
Array of objects containing variant products for each variant
- Name
productId
- Type
- string
- Description
Unique id of the Product
- Name
isDefault
- Type
- boolean
- Description
Flag to check is brand by default selected or not
- Name
tax
- Type
- number
- Description
Tax to be included in the price
- Name
isPreOrderEnabled
- Type
- boolean
- Description
Flag to check is preOrder enabled or not
- Name
reviews
- Type
- object
- Description
Object containing list of reviews
- Name
relatedProducts
- Type
- array
- Description
Array of objects containing related products
- Name
relatedTypeCode
- Type
- string
- Description
Defines the group to which related products belong
- Name
relationDirectionCode
- Type
- string
- Description
Defines the relation direction code for the entity
- Name
hasVariant
- Type
- boolean
- Description
Flag to check Is variant available or not
- Name
sku
- Type
- string
- Description
Defines the group to which related products belong
- Name
freeProducts
- Type
- array
- Description
Array containing information about Free products
- Name
subscriptionEnabled
- Type
- boolean
- Description
Flag to check is subscription enabled or not
- Name
subscriptionPlanType
- Type
- string
- Description
Type of the subscription plan
- Name
componentProducts
- Type
- object
- Description
List of products included as components
- Name
soldIndependently
- Type
- boolean
- Description
Flag to check if product can be sold independently or not
- Name
componentsInStock
- Type
- boolean
- Description
Flag to check if components are in stock or not
- Name
displayInBasket
- Type
- boolean
- Description
Flag to check if displayInBasket true or not
Request
curl --location --request POST 'https://api20.bettercommerce.io/api/v2/catalog/product/preview?slug=products%2Fmy-brand-cotton-racerback-spaghetti-top-women-black-1-bs0010-black-s'
Response
{
"statusCode": 200,
"status": "OK",
"errors": [],
"success": true,
"message": null,
"messageCode": null,
"result": {
"id": "5642869781",
"recordId": "265badde-ee82-401a-95a7-ad5e0048ca58",
"productCode": "BS20560",
"stockCode": "BS20560-BLACK-ONESIZE",
"barcode": "056428378834",
"name": "Black Poncho Jumper with Camel & Cream Stripes",
"fullName": "My Brand Black Poncho Jumper with Camel & Cream Stripes",
"seoName": "",
"metaTitle": "My Brand Black Poncho Jumper with Camel & Cream Stripes | Betterstore",
"metaDescription": "Buy My Brand Black Poncho Jumper with Camel & Cream Stripes online at Betterstore. Next-day delivery is available.",
"metaKeywords": "My Brand Black Poncho Jumper with Camel & Cream Stripes | Betterstore",
"canonicalTags": "",
"link": "products/my-brand-black-poncho-jumper-with-camel-cream-stripes-bs20560-black-onesize",
"shortDescription": "",
"description": "<p>A must-have for the winter season, our Black Poncho Jumper is the perfect hybrid of an oversized super soft jumper and a stylish poncho cape. Plush stripes in black and cream add a bit of something different. Keep it chilled and wear over leggings or pair with black skinnies and heels for a sophisticated autumn/winter outfit. Also available in camel.</p>\n\n<p><strong>DETAILS</strong></p>\n\n<ul>\n\t<li><strong>Poncho Style Jumper</strong></li>\n\t<li><strong>Plush Stripes</strong></li>\n\t<li><strong>High Neck</strong></li>\n\t<li><strong>Elasticated Sleeves</strong></li>\n</ul>\n\n<p><strong>SIZE & FIT</strong></p>\n\n<p>Seema wears ONE SIZE (Approx UK 6-16 dependant on desired fit)</p>\n\n<p>Model height 5'3"</p>\n\n<p><strong>LOOK AFTER ME</strong></p>\n\n<p>Machine wash on cool</p>\n\n<p>Do not bleach</p>\n\n<p>Cool iron on reverse</p>\n\n<p>Do not tumbel dry</p>\n\n<p>Do not dry clean</p>\n\n<p><strong>MATERIAL</strong></p>\n\n<p>55% Viscose 27% Acrylic 18% Nylon</p>\n ",
"notes": "",
"brand": "My Brand",
"brandLogo": "https://liveocxstorage.blob.core.windows.net/betterstore/logo/mybrand.png",
"brandId": 9664,
"brandRecordId": "fcf551c5-ccb5-4214-9b2b-ad5e003dc1a1",
"subBrand": "",
"subBrandId": "0",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£59.99",
"withoutTax": "£59.99",
"tax": "£39.99"
},
"raw": {
"withTax": 59.99,
"withoutTax": 59.99,
"tax": 39.99
}
},
"price": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£20.00",
"withoutTax": "£20.00",
"tax": "£0.00"
},
"raw": {
"withTax": 20,
"withoutTax": 20,
"tax": 0
}
},
"attributeSet": null,
"uom": "",
"uomValue": "0",
"dimensions": null,
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex20560_black_5092.webp?fm=webp",
"images": [
{
"name": "Image1",
"tag": "Black Poncho Jumper with Camel & Cream Stripes",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex20560_black_5092.webp?fm=webp",
"imageTypes": null,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/ex20560_black_5092.webp?fm=webp",
"mobileUrl": null,
"alt": null,
"link": null,
"description": null,
"subTitle": null,
"linkType": null,
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": false,
"cssClass": null,
"title": null,
"displayOrder": 0,
"imageTags": []
}
],
"videos": null,
"pdFs": null,
"availability": 0,
"seoAvailability": null,
"deliveryMessage": null,
"stockAvailabilityMessage": null,
"fulfilFromWarehouse": false,
"fulfilFromStore": false,
"fulfilFromSupplier": false,
"fulfilFromWarehouseDays": 0,
"fulfilFromSupplierDays": 0,
"fulfilFromInstoreDays": 0,
"currentStock": 236,
"rating": 0,
"displayTemplate": "",
"isDiscontinued": false,
"isVisible": true,
"breadCrumbs": [
{
"slugType": "Manufacturer",
"slug": {
"title": "",
"slug": "my-brand-url",
"childSlug": null
}
}
],
"classification": {
"categoryCode": "be4e4a38-e2f7-45cb-b586-4c65664d271c",
"category": "PONCHOS",
"itemTypeCode": null,
"itemType": "1",
"attributeSet": "Default Attribute set",
"attributeSetId": "227edf33-1894-43fe-acba-13c795c5c564",
"mainCategoryId": "6e3252f0-b8d5-473e-8b1f-60b62d82b5d5",
"mainCategoryName": "KNITWEAR"
},
"isGiftWrapApplied": false,
"giftWrapConfig": null,
"promotions": [
{
"promoCode": "CATSALE",
"name": "Category Sale"
}
],
"collections": null,
"flags": {
"sellWithoutInventory": false,
"isFreeDelivery": false
},
"preOrder": {
"shortMessage": "",
"message": "",
"currentStock": 0,
"maxStock": 0,
"isEnabled": false,
"launchDateTime": "1900-01-01T00:00:00"
},
"couponProvider": null,
"customAttributes": [
{
"key": "clothing.size",
"customkey": "clothing.size~onesize~Size",
"display": "Size",
"value": "onesize",
"originalValue": null,
"isVariantAttribute": true,
"displayInProductDetail": true,
"displayInProductList": false,
"groupDisplayOrder": 0
}
],
"variantAttributes": [
{
"fieldName": "Size",
"fieldCode": "clothing.size",
"fieldLabel": null,
"inputType": null,
"fieldValues": [],
"independentProductUrl": false,
"displayInProductDetail": true,
"displayInProductWidget": true
}
],
"variantProducts": [],
"reviews": null,
"relatedProducts": [
{
"productId": "11cc48f2-23eb-4579-8836-383a61ad2ea3",
"name": "Personalization",
"stockCode": "ADDON",
"relatedTypeCode": "ADDONS",
"relationDirectionCode": null,
"images": [
{
"name": "Image1",
"tag": null,
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/addon.jfif?fm=webp",
"imageTypes": null,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/products/addon.jfif?fm=webp",
"mobileUrl": null,
"alt": null,
"link": null,
"description": null,
"subTitle": null,
"linkType": null,
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": false,
"cssClass": null,
"title": null,
"displayOrder": 0,
"imageTags": []
}
],
"shortDescription": "<p>This is an add-on product for personalization.</p>\n",
"description": "<p>This is an add-on product for personalization.</p>\n",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/addon.jfif?fm=webp",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£0.00",
"withoutTax": "£0.00",
"tax": "£-1.99"
},
"raw": {
"withTax": 0,
"withoutTax": 0,
"tax": -1.99
}
},
"price": {
"minPrice": 1.99,
"minPriceWithoutTax": 1.99,
"maxPrice": 1.99,
"maxPriceWithoutTax": 1.99,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£1.99",
"withoutTax": "£1.99",
"tax": "£0.00"
},
"raw": {
"withTax": 1.99,
"withoutTax": 1.99,
"tax": 0
}
},
"slug": "products/my-brand-personalization-addon",
"currentStock": 9992,
"brand": "My Brand",
"subBrand": "",
"hasVariant": false,
"itemType": 10,
"sku": "ADDON"
}
],
"freeProducts": null,
"subscriptionEnabled": false,
"subscriptionPlanType": 0,
"componentProducts": null,
"soldIndependently": true,
"componentsInStock": false,
"displayInBasket": false
}
}
Get product details by slug
This endpoint retrieves a product by the slug & various attributes passed.
Developers - API Operations for different responses:
Operation | Endpoint | Response |
---|---|---|
Get product details by slug | /api/v2/catalog/product/slug?slug={{product_slug}} | OK - Product Details |
Get product details by slug | /api/v2/catalog/product/slug?slug={{product_slug}} | OK - Variant |
Get product details by slug | /api/v2/catalog/product/slug?slug={{product_slug}} | OK - Bundle |
Get product details by slug | /api/v2/catalog/product/slug?slug={{product_slug}} | OK - with RelatedProducts (eg. Engraving) |
Get product details by slug | /api/v2/catalog/product/slug?slug={{product_slug}} | OK - with Reviews |
Get product details by slug | /api/v2/catalog/product/slug?slug={{product_slug}} | OK - with Video |
Required attributes
- Name
slug
- Type
- string
- Description
Slug to be passed to retreive details
Response attributes
- Name
statusCode
- Type
- number
- Description
Status code of the response
- Name
status
- Type
- string
- Description
Status of the response
- Name
errors
- Type
- array
- Description
List of errors in the response
- Name
success
- Type
- boolean
- Description
Success status of the response
- Name
message
- Type
- string
- Description
Message of the response
- Name
messageCode
- Type
- string
- Description
Message code of the response
- Name
result
- Type
- object
- Description
Result of the response
- Name
id
- Type
- string
- Description
Id of the category
- Name
name
- Type
- string
- Description
Name of the category
- Name
recordId
- Type
- string
- Description
Id of the Product in Brand Record
- Name
stockCode
- Type
- string
- Description
Unique id of the stock
- Name
barcode
- Type
- string
- Description
Unique value for each product
- Name
fullName
- Type
- string
- Description
Full name of the product
- Name
seoName
- Type
- string
- Description
SEO Name
- Name
metaTitle
- Type
- string
- Description
MetaTitle associated with the product
- Name
metaDescription
- Type
- string
- Description
MetaDescription associated with the product
- Name
canonicalTags
- Type
- string
- Description
Cannonical Tags associated with the product
- Name
metaKeywords
- Type
- string
- Description
MetaKeywords associated with the product
- Name
link
- Type
- string
- Description
Link of the product
- Name
shortDescription
- Type
- string
- Description
Short description of the product
- Name
description
- Type
- string
- Description
The description for the product.
- Name
brand
- Type
- string
- Description
Name of the brand
- Name
brandLogo
- Type
- string
- Description
Logo of the brand
- Name
subBrand
- Type
- string
- Description
SubBrand of parent Brand
- Name
minPrice
- Type
- number
- Description
Minimum price of the product
- Name
maxPrice
- Type
- number
- Description
Maximum price of the product
- Name
maxPriceWithoutTax
- Type
- number
- Description
Maximum price of the product without tax
- Name
currencyDecimalSeparator
- Type
- number
- Description
Property to separate decimal from the currency
- Name
formatted
- Type
- string
- Description
Contains the list of Price attributes of the product
- Name
withTax
- Type
- number
- Description
Price with tax
- Name
withoutTax
- Type
- number
- Description
Price without tax
- Name
tax
- Type
- number
- Description
Tax to be included in the price
- Name
raw
- Type
- number
- Description
Price of the product without any taxes
- Name
sellPrice
- Type
- number
- Description
Price of the product to be sold
- Name
imageTypes
- Type
- number
- Description
Image types as integer
- Name
tag
- Type
- string
- Description
Tag associated with the Product
- Name
url
- Type
- string
- Description
URL of the Image
- Name
mobileUrl
- Type
- string
- Description
URL for mobile
- Name
alt
- Type
- string
- Description
Alternate text to be added in Image
- Name
link
- Type
- string
- Description
Link of the product
- Name
description
- Type
- string
- Description
Description of the product
- Name
subTitle
- Type
- string
- Description
Subtitle of the Category
- Name
linkType
- Type
- string
- Description
Name of the Logo Image
- Name
buttonText
- Type
- string
- Description
Text to be added in button
- Name
eventCategory
- Type
- string
- Description
Category of the event
- Name
eventAction
- Type
- string
- Description
Action of the event
- Name
gaValue
- Type
- string
- Description
Value of the GA data
- Name
isActive
- Type
- string
- Description
Flag to check the Active status
- Name
displayOrder
- Type
- number
- Description
Order of the display associated with the product
- Name
imageTags
- Type
- array
- Description
Tags associated with each Image
- Name
videos
- Type
- array
- Description
Videos associated with each product
- Name
pdfs
- Type
- array
- Description
Pdfs associated with each product
- Name
availability
- Type
- number
- Description
Availability count of the product
- Name
seoAvailability
- Type
- string
- Description
Defines Is Seo available with the Product
- Name
fulfillFromStore
- Type
- boolean
- Description
Flag to check is fulfilFromStore or not
- Name
fulfillFromSupplier
- Type
- boolean
- Description
Flag to check is fulfilFromSupplier or not
- Name
deliveryMessage
- Type
- string
- Description
Message for the delivery
- Name
stockAvailabilityMessage
- Type
- string
- Description
Message to check stock availability
- Name
fulfillFromSupplierDays
- Type
- number
- Description
Number of days for the product to reach the customer from the supplier
- Name
fulfillFromWarehouseDays
- Type
- number
- Description
Number of days for the product to reach the supplier from the warehouse
- Name
currentStock
- Type
- number
- Description
Value of the current stock of particular product
- Name
rating
- Type
- number
- Description
Value of the rating of the particular product
- Name
displayTemplate
- Type
- string
- Description
Template for display of attribute
- Name
isDiscontinued
- Type
- boolean
- Description
Flag to check is discontinued or not
- Name
isVisible
- Type
- boolean
- Description
Flag to check is visible enabled or not
- Name
breadCrumbs
- Type
- array
- Description
Array to sort in the List.
- Name
slugType
- Type
- string
- Description
Describes the type of slug.
- Name
slug
- Type
- string
- Description
Link associated with each Collection
- Name
categoryCode
- Type
- string
- Description
Category Code
- Name
category
- Type
- string
- Description
Category of the product
- Name
itemType
- Type
- string
- Description
Type of the item
- Name
itemTypeCode
- Type
- string
- Description
Code for the itemType
- Name
attributeSetId
- Type
- string
- Description
Id for each of the attributes
- Name
mainCategoryId
- Type
- string
- Description
Main category Id
- Name
mainCategoryName
- Type
- string
- Description
Main category name
- Name
isGiftWrapApplied
- Type
- boolean
- Description
Flag to check if gift wrap applied or not
- Name
giftWrapConfig
- Type
- string
- Description
Configuration of the gift wrap
- Name
promotions
- Type
- array
- Description
Array containing attributes for promotions
- Name
promoCode
- Type
- string
- Description
Unique promo Code for each promotion.
- Name
collections
- Type
- array
- Description
Array containing attributes for collections
- Name
colectionId
- Type
- string
- Description
Collection Id
- Name
flags
- Type
- object
- Description
An Object that stores the Flags to be set
- Name
sellWithoutInventory
- Type
- boolean
- Description
Flag to check if sellWithoutInventory flag is true or false
- Name
isFreeDelivery
- Type
- boolean
- Description
Flag to check is delivery free or not
- Name
preOrder
- Type
- array
- Description
Array containing attributes for order
- Name
isEnabled
- Type
- boolean
- Description
Flag to check Is order enabled or not
- Name
launchDateTime
- Type
- string
- Description
Launch & date time of the order
- Name
customAttributes
- Type
- array
- Description
Array containing list of attributes for the particular product
- Name
customkey
- Type
- string
- Description
custom key of the brand
- Name
isVariantAttribute
- Type
- boolean
- Description
Flag to check is attribute, variant attribute of the product or not
- Name
displayInProductList
- Type
- boolean
- Description
Flag to check display in product list
- Name
displayInProductDetails
- Type
- boolean
- Description
Flag to check display in product details
- Name
groupDisplayOrder
- Type
- number
- Description
Order of the group display
- Name
fieldName
- Type
- string
- Description
Name of the field
- Name
fieldCode
- Type
- string
- Description
Unique Code corresponding to the field
- Name
fieldLabel
- Type
- string
- Description
Label of the field
- Name
inputType
- Type
- string
- Description
Defines the Input type of the attribute
- Name
fieldValues
- Type
- string
- Description
Contains value of the field
- Name
fieldValue
- Type
- number
- Description
Unique code of the Field
- Name
independentProductUrl
- Type
- string
- Description
Independent product URL
- Name
displayInProductWidget
- Type
- boolean
- Description
Display in product widget
- Name
variantProducts
- Type
- array
- Description
Array of objects containing variant products for each variant
- Name
productId
- Type
- string
- Description
Unique id of the Product
- Name
isDefault
- Type
- boolean
- Description
Flag to check is brand by default selected or not
- Name
tax
- Type
- number
- Description
Tax to be included in the price
- Name
isPreOrderEnabled
- Type
- boolean
- Description
Flag to check is preOrder enabled or not
- Name
reviews
- Type
- object
- Description
Object containing list of reviews
- Name
relatedProducts
- Type
- array
- Description
Array of objects containing related products
- Name
relatedTypeCode
- Type
- string
- Description
Defines the group to which related products belong
- Name
hasVariant
- Type
- boolean
- Description
Flag to check Is variant available or not
- Name
sku
- Type
- string
- Description
Defines the group to which related products belong
- Name
freeProducts
- Type
- array
- Description
Array containing information about Free products
- Name
subscriptionEnabled
- Type
- boolean
- Description
Flag to check is subscription enabled or not
- Name
subscriptionPlanType
- Type
- string
- Description
Type of the subscription plan
- Name
componentProducts
- Type
- object
- Description
List of products included as components
- Name
soldIndependently
- Type
- boolean
- Description
Flag to check if product can be sold independently or not
- Name
componentsInStock
- Type
- boolean
- Description
Flag to check if components are in stock or not
- Name
displayInBasket
- Type
- boolean
- Description
Flag to check if displayInBasket true or not
Request
curl --location -g --request POST '/api/v2/catalog/product/slug?slug=products/my-brand-stylish-summer-jacket-whtspot1-black-bs00041-black-4'
Response : OK - Product Details
{
"statusCode": 200,
"status": "OK",
"errors": [],
"success": true,
"message": null,
"messageCode": null,
"result": {
"id": "5642873261",
"recordId": "cee87c94-bde4-4e85-aa65-295017a36a9d",
"productCode": "BS00041",
"stockCode": "BS00041-BLACK-6",
"barcode": "056428732614",
"name": "Stylish Summer Jacket WHTSPOT1 BLACK",
"fullName": "My Brand Stylish Summer Jacket WHTSPOT1 BLACK",
"seoName": "",
"metaTitle": "My Brand Stylish Summer Jacket WHTSPOT1 BLACK | Betterstore",
"metaDescription": "Buy My Brand Stylish Summer Jacket WHTSPOT1 BLACK online at Betterstore. Next-day delivery is available.",
"metaKeywords": "My Brand Stylish Summer Jacket WHTSPOT1 BLACK | Betterstore",
"canonicalTags": "",
"link": "products/my-brand-stylish-summer-jacket-whtspot1-black-bs00041-black-4",
"shortDescription": "<html>\n<head>\n\t<title></title>\n</head>\n<body data-gr-ext-installed=\"\" data-new-gr-c-s-check-loaded=\"14.1027.0\">\n<p><br />\n<grammarly-desktop-integration data-grammarly-shadow-root=\"true\"></grammarly-desktop-integration></p>\n</body>\n</html>\n",
"description": "<html>\n<head>\n\t<title></title>\n</head>\n<body data-gr-ext-installed=\"\" data-new-gr-c-s-check-loaded=\"14.1027.0\">\n<p><br />\n<grammarly-desktop-integration data-grammarly-shadow-root=\"true\"></grammarly-desktop-integration></p>\n</body>\n</html>\n",
"notes": "",
"brand": "My Brand",
"brandLogo": "https://liveocxstorage.blob.core.windows.net/betterstore/logo/mybrand.png",
"brandId": 9664,
"brandRecordId": "fcf551c5-ccb5-4214-9b2b-ad5e003dc1a1",
"subBrand": "",
"subBrandId": "0",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£39.99",
"withoutTax": "£39.99",
"tax": "£0.00"
},
"raw": {
"withTax": 39.99,
"withoutTax": 39.99,
"tax": 0
}
},
"price": {
"minPrice": 39.99,
"minPriceWithoutTax": 39.99,
"maxPrice": 39.99,
"maxPriceWithoutTax": 39.99,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£39.99",
"withoutTax": "£39.99",
"tax": "£0.00"
},
"raw": {
"withTax": 39.99,
"withoutTax": 39.99,
"tax": 0
}
},
"attributeSet": null,
"uom": null,
"uomValue": "0",
"dimensions": null,
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/tara_drop_one24.jpg?fm=webp",
"images": [
{
"name": "Image1",
"tag": null,
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/tara_drop_one24.jpg?fm=webp",
"imageTypes": null,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/products/tara_drop_one24.jpg?fm=webp",
"mobileUrl": null,
"alt": null,
"link": null,
"description": null,
"subTitle": null,
"linkType": null,
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": false,
"cssClass": null,
"title": null,
"displayOrder": 0,
"imageTags": []
}
],
"videos": [
{
"productId": "cee87c94-bde4-4e85-aa65-295017a36a9d",
"recordId": "00000000-0000-0000-0000-000000000000",
"url": "https://player.vimeo.com/video/587060172",
"isDefault": true,
"displayOrder": 1
}
],
"pdFs": null,
"availability": 0,
"seoAvailability": null,
"deliveryMessage": null,
"stockAvailabilityMessage": null,
"fulfilFromWarehouse": true,
"fulfilFromStore": false,
"fulfilFromSupplier": false,
"fulfilFromWarehouseDays": 0,
"fulfilFromSupplierDays": 0,
"fulfilFromInstoreDays": 0,
"currentStock": -2,
"rating": 0,
"displayTemplate": "",
"isDiscontinued": false,
"isVisible": true,
"breadCrumbs": [
{
"slugType": "Manufacturer",
"slug": {
"title": "My Brand",
"slug": "my-brand-url",
"childSlug": null
}
}
],
"classification": {
"categoryCode": "418eb31e-fd2a-419a-a2ce-e9f83e48de87",
"category": "BLAZERS",
"itemTypeCode": null,
"itemType": "1",
"attributeSet": "Default Attribute set",
"attributeSetId": "227edf33-1894-43fe-acba-13c795c5c564",
"mainCategoryId": "982fa32a-dc58-4758-b066-19110feea393",
"mainCategoryName": "JACKETS"
},
"isGiftWrapApplied": false,
"giftWrapConfig": null,
"promotions": null,
"collections": [
{
"collectionId": "36bdedaf-4513-48a7-8b5f-ad71006e500c",
"name": "black"
}
],
"flags": {
"sellWithoutInventory": false,
"isFreeDelivery": false
},
"preOrder": {
"shortMessage": "preorder",
"message": "",
"currentStock": 0,
"maxStock": 100,
"isEnabled": true,
"launchDateTime": "2022-02-01T00:00:00"
},
"couponProvider": null,
"customAttributes": [
{
"key": "global.colour",
"customkey": "global.colour~#000000~Colour",
"display": "Colour",
"value": "#000000",
"originalValue": null,
"isVariantAttribute": true,
"displayInProductDetail": true,
"displayInProductList": false,
"groupDisplayOrder": 0
}
],
"variantAttributes": [
{
"fieldName": "Size",
"fieldCode": "clothing.size",
"fieldLabel": null,
"inputType": "Dropdown",
"fieldValues": [
{
"fieldValue": "4",
"fieldLabel": ""
}
],
"independentProductUrl": false,
"displayInProductDetail": true,
"displayInProductWidget": true
}
],
"variantProducts": [
{
"stockCode": "BS00041-WHTSPOT-4",
"productId": "b6b86122-e4e6-4ce6-a74f-8e4ba7131cd0",
"slug": "products/my-brand-stylish-summer-jacket-whtspot1-whtspot-bs00041-whtspot-4",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/jj23.jpg?fm=webp",
"productName": "Stylish Summer Jacket WHTSPOT1 WHTSPOT",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£39.99",
"withoutTax": "£39.99",
"tax": "£0.00"
},
"raw": {
"withTax": 39.99,
"withoutTax": 39.99,
"tax": 0
}
},
"price": {
"minPrice": 39.99,
"minPriceWithoutTax": 39.99,
"maxPrice": 39.99,
"maxPriceWithoutTax": 39.99,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£39.99",
"withoutTax": "£39.99",
"tax": "£0.00"
},
"raw": {
"withTax": 39.99,
"withoutTax": 39.99,
"tax": 0
}
},
"isDefault": false,
"isPreOrderEnabled": true,
"sellWithoutInventory": false,
"currentStock": -6,
"description": null,
"attributes": [
{
"fieldCode": "clothing.size",
"fieldName": "Size",
"fieldValue": "4",
"fieldLabel": ""
}
]
}
],
"reviews": null,
"relatedProducts": [
{
"productId": "4b674be4-22e2-41f5-91cc-b6780fee3799",
"name": "Funnel neck long sleeve GHOST WHITE",
"stockCode": "BS002-GHOST-WHITE-M",
"relatedTypeCode": "ALSOLIKE",
"relationDirectionCode": "Product",
"images": [
{
"name": "Image1",
"tag": null,
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/wt1.jpg?fm=webp",
"imageTypes": null,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/products/wt1.jpg?fm=webp",
"mobileUrl": null,
"alt": null,
"link": null,
"description": null,
"subTitle": null,
"linkType": null,
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": false,
"cssClass": null,
"title": null,
"displayOrder": 0,
"imageTags": []
}
],
"shortDescription": "<p>A long sleeve top featuring funnel neck detail.</p>\n",
"description": "<p>A long sleeve top featuring funnel neck detail.</p>\n",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/wt1.jpg?fm=webp",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£0.00",
"withoutTax": "£0.00",
"tax": "£-16.00"
},
"raw": {
"withTax": 0,
"withoutTax": 0,
"tax": -16
}
},
"price": {
"minPrice": 16,
"minPriceWithoutTax": 16,
"maxPrice": 16,
"maxPriceWithoutTax": 16,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£16.00",
"withoutTax": "£16.00",
"tax": "£0.00"
},
"raw": {
"withTax": 16,
"withoutTax": 16,
"tax": 0
}
},
"slug": "products/my-brand-funnel-neck-long-sleeve-ghost-white-bs002-ghost-white-m",
"currentStock": 81,
"brand": "My Brand",
"subBrand": "",
"hasVariant": true,
"itemType": 1,
"sku": "BS002-GHOST-WHITE-M"
}
],
"freeProducts": [],
"subscriptionEnabled": false,
"subscriptionPlanType": 0,
"componentProducts": null,
"soldIndependently": true,
"componentsInStock": false,
"displayInBasket": false
},
"snippets": [
{
"name": "canishub_pdp",
"type": "Javascript",
"placement": "Head",
"content": "<script>\n\nwindow.addEventListener(\"load\",function(){\n var prodData = JSON.parse(dataLayer[0].entity);\n\tvar prodInfo = prodData.stockCode.split(\"-\")\n\tvar prodColor = prodInfo.slice(1,prodInfo.length-1).join('-');\n\tvar prodSize = prodInfo[prodInfo.length-1];\n\tvar itemId = prodInfo.slice(0,prodInfo.length-1).join('-');\n\n\n var prodData = JSON.parse(dataLayer[0].entity);\n let item = {\n item_id:itemId,\n title: prodData.name,\n sku: prodData.sku,\n categories: prodData.rootManufacturer, \t\t\t\n base_category:prodData.rootManufacturer, \t\n collection_name: '', \n description: prodData.name,\n product_url: getLiveUrl(window.location.href),\n image_url: prodData.img,\n condition: prodData.itemCondition,\n availability: prodData.availability,\n price: prodData.price.toFixed(2).toString(), \t\t\t\t\n sale_price: prodData.price.toFixed(2).toString(), \t\t\n brand: prodData.manufacturer,\n variant: {\n id: itemId,\n title: prodData.name,\n sku: prodData.sku,\n image_url:prodData.img,\n product_url: getLiveUrl(window.location.href), //getLiveUrl function is created in header snippet \n price: prodData.price.toFixed(2).toString(), \t\t\t\t\n sale_price:prodData.price.toFixed(2).toString(), \n availability: prodData.availability, \n metadata: {\n color: prodColor,\n size: prodSize,\n weight: 0,\n weight_unit: '',\n make: '',\n model: prodData.manufacturer,\n rating: 0\n }\n }\n };\n ch_pub_sub_events.publish('product_view_before', { 'item_id': item.item_id, 'item': item });\n\n},false);\n\n\n</script>",
"excludedUrl": null,
"microsites": [
"9413609e-635f-44ac-b697-ad5e00cd21dc",
]
}
],
"slugType": 1
}
Response : OK - Variant
{
"statusCode": 200,
"status": "OK",
"errors": [],
"success": true,
"message": null,
"messageCode": null,
"result": {
"id": "5642872665",
"recordId": "e0bdeeb8-bd74-477b-b36b-535a21739e2a",
"productCode": "BS0010",
"stockCode": "BS0010-BLACK-L",
"barcode": "056428726654",
"name": "Cotton Racerback Spaghetti top for Women BLACK",
"fullName": "My Brand Cotton Racerback Spaghetti top for Women BLACK",
"seoName": "",
"metaTitle": "My Brand Cotton Racerback Spaghetti top for Women BLACK | Betterstore",
"metaDescription": "Buy My Brand Cotton Racerback Spaghetti top for Women BLACK online at Betterstore. Next-day delivery is available.",
"metaKeywords": "My Brand Cotton Racerback Spaghetti top for Women BLACK | Betterstore",
"canonicalTags": "",
"link": "products/my-brand-cotton-racerback-spaghetti-top-women-black-1-bs0010-black-s",
"shortDescription": "<p>Care Instructions: Care Instructions: Gentle Wash | Hand Wash | Do not Iron Directly<br />\nFabric: Cotton<br />\nFitting: Modern fit / Style : Racer back<br />\nPurpose : To be worn as lounge wear, leisure wear and Active wear - for all purpose use<br />\nLabel free for all day comfort<br />\nContoured armholes and neckline with delicate finish</p>\n",
"description": "<p>Care Instructions: Care Instructions: Gentle Wash | Hand Wash | Do not Iron Directly<br />\nFabric: Cotton<br />\nFitting: Modern fit / Style : Racer back<br />\nPurpose : To be worn as lounge wear, leisure wear and Active wear - for all purpose use<br />\nLabel free for all day comfort<br />\nContoured armholes and neckline with delicate finish</p>\n",
"notes": "",
"brand": "My Brand",
"brandLogo": "https://liveocxstorage.blob.core.windows.net/betterstore/logo/mybrand.png",
"brandId": 9664,
"brandRecordId": "fcf551c5-ccb5-4214-9b2b-ad5e003dc1a1",
"subBrand": "",
"subBrandId": "0",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£100.00",
"withoutTax": "£100.00",
"tax": "£20.00"
},
"raw": {
"withTax": 100,
"withoutTax": 100,
"tax": 20
}
},
"price": {
"minPrice": 80,
"minPriceWithoutTax": 80,
"maxPrice": 80,
"maxPriceWithoutTax": 80,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£80.00",
"withoutTax": "£80.00",
"tax": "£0.00"
},
"raw": {
"withTax": 80,
"withoutTax": 80,
"tax": 0
}
},
"attributeSet": null,
"uom": null,
"uomValue": "0",
"dimensions": null,
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/black1.jpg?fm=webp",
"images": [
{
"name": "Image1",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/black1.jpg?fm=webp",
"alt": null
}
],
"videos": null,
"pdFs": null,
"availability": 2,
"seoAvailability": "OutOfStock",
"deliveryMessage": null,
"stockAvailabilityMessage": null,
"fulfilFromWarehouse": true,
"fulfilFromStore": false,
"fulfilFromSupplier": false,
"fulfilFromWarehouseDays": 0,
"fulfilFromSupplierDays": 0,
"fulfilFromInstoreDays": 0,
"currentStock": 0,
"rating": 0,
"displayTemplate": "",
"isDiscontinued": false,
"isVisible": true,
"breadCrumbs": [
{
"slugType": "Manufacturer",
"slug": {
"title": "My Brand",
"slug": "my-brand-url",
"childSlug": null
}
}
],
"classification": {
"categoryCode": "ab002119-6095-46bc-a308-6ece71b26fc0",
"category": "Clothing",
"itemTypeCode": null,
"itemType": "1",
"attributeSet": "Default Attribute set",
"attributeSetId": "227edf33-1894-43fe-acba-13c795c5c564",
"mainCategoryId": "ab002119-6095-46bc-a308-6ece71b26fc0",
"mainCategoryName": "Clothing"
},
"isGiftWrapApplied": false,
"giftWrapConfig": null,
"promotions": null,
"collections": [
{
"collectionId": "3eb7d627-66d8-468a-a274-ad60006bfd6e",
"name": "An Ideal day"
}
],
"flags": {
"sellWithoutInventory": false,
"isFreeDelivery": false
},
"preOrder": {
"shortMessage": "",
"message": "",
"currentStock": 0,
"maxStock": 0,
"isEnabled": false,
"launchDateTime": "1900-01-01T00:00:00"
},
"couponProvider": null,
"customAttributes": [
{
"key": "global.colour",
"customkey": "global.colour~#000000~Colour",
"display": "Colour",
"value": "#000000",
"originalValue": null,
"isVariantAttribute": true,
"displayInProductDetail": true,
"displayInProductList": false,
"groupDisplayOrder": 0
}
],
"variantAttributes": [
{
"fieldName": "Size",
"fieldCode": "clothing.size",
"fieldLabel": null,
"inputType": "Dropdown",
"fieldValues": [
{
"fieldValue": "s",
"fieldLabel": ""
}
],
"independentProductUrl": false,
"displayInProductDetail": true,
"displayInProductWidget": true
}
],
"variantProducts": [
{
"stockCode": "BS0010-BLACK-S",
"productId": "a82c4f3b-e7c3-4bb1-b74c-b395f462f721",
"slug": "products/my-brand-cotton-racerback-spaghetti-top-women-black-1-bs0010-black-s",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/black1.jpg?fm=webp",
"productName": "Cotton Racerback Spaghetti top for Women BLACK",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£100.00",
"withoutTax": "£100.00",
"tax": "£20.00"
},
"raw": {
"withTax": 100,
"withoutTax": 100,
"tax": 20
}
},
"price": {
"minPrice": 80,
"minPriceWithoutTax": 80,
"maxPrice": 80,
"maxPriceWithoutTax": 80,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£80.00",
"withoutTax": "£80.00",
"tax": "£0.00"
},
"raw": {
"withTax": 80,
"withoutTax": 80,
"tax": 0
}
},
"isDefault": false,
"isPreOrderEnabled": false,
"sellWithoutInventory": false,
"currentStock": 389,
"description": null,
"attributes": [
{
"fieldCode": "clothing.size",
"fieldName": "Size",
"fieldValue": "s",
"fieldLabel": ""
}
]
}
],
"reviews": null,
"relatedProducts": null,
"freeProducts": [],
"subscriptionEnabled": false,
"subscriptionPlanType": 0,
"componentProducts": null,
"soldIndependently": true,
"componentsInStock": false,
"displayInBasket": false
},
"snippets": [
{
"name": "canishub_pdp",
"type": "Javascript",
"placement": "Head",
"content": "<script>\n\nwindow.addEventListener(\"load\",function(){\n var prodData = JSON.parse(dataLayer[0].entity);\n\tvar prodInfo = prodData.stockCode.split(\"-\")\n\tvar prodColor = prodInfo.slice(1,prodInfo.length-1).join('-');\n\tvar prodSize = prodInfo[prodInfo.length-1];\n\tvar itemId = prodInfo.slice(0,prodInfo.length-1).join('-');\n\n\n var prodData = JSON.parse(dataLayer[0].entity);\n let item = {\n item_id:itemId,\n title: prodData.name,\n sku: prodData.sku,\n categories: prodData.rootManufacturer, \t\t\t\n base_category:prodData.rootManufacturer, \t\n collection_name: '', \n description: prodData.name,\n product_url: getLiveUrl(window.location.href),\n image_url: prodData.img,\n condition: prodData.itemCondition,\n availability: prodData.availability,\n price: prodData.price.toFixed(2).toString(), \t\t\t\t\n sale_price: prodData.price.toFixed(2).toString(), \t\t\n brand: prodData.manufacturer,\n variant: {\n id: itemId,\n title: prodData.name,\n sku: prodData.sku,\n image_url:prodData.img,\n product_url: getLiveUrl(window.location.href), //getLiveUrl function is created in header snippet \n price: prodData.price.toFixed(2).toString(), \t\t\t\t\n sale_price:prodData.price.toFixed(2).toString(), \n availability: prodData.availability, \n metadata: {\n color: prodColor,\n size: prodSize,\n weight: 0,\n weight_unit: '',\n make: '',\n model: prodData.manufacturer,\n rating: 0\n }\n }\n };\n ch_pub_sub_events.publish('product_view_before', { 'item_id': item.item_id, 'item': item });\n\n},false);\n\n\n</script>",
"excludedUrl": null,
"microsites": [
"9413609e-635f-44ac-b697-ad5e00cd21dc",
]
}
],
"slugType": 1
}
Response : OK - Bundle
{
"statusCode": 200,
"status": "OK",
"errors": [],
"success": true,
"message": null,
"messageCode": null,
"result": {
"id": "5642873545",
"recordId": "cdeea2dc-c4a8-4a70-9a89-0b01623ed1b5",
"productCode": "BNDLE002",
"stockCode": "BNDLE002",
"barcode": "056428735454",
"name": "Test Bundle for demo",
"fullName": "My Brand Test Bundle for demo",
"seoName": "",
"metaTitle": "My Brand Test Bundle for demo | Betterstore",
"metaDescription": "Buy My Brand Test Bundle for demo online at Betterstore. Next-day delivery is available.",
"metaKeywords": "My Brand Test Bundle for demo | Betterstore",
"canonicalTags": "",
"link": "products/my-brand-test-bundle-demo-bndle002",
"shortDescription": "<html>\n<head>\n\t<title></title>\n</head>\n<body data-gr-ext-installed=\"\" data-new-gr-c-s-check-loaded=\"14.1025.0\">\n<p>Test Description</p>\n</body>\n<grammarly-desktop-integration data-grammarly-shadow-root=\"true\"></grammarly-desktop-integration></html>\n",
"description": "<html>\n<head>\n\t<title></title>\n</head>\n<body data-gr-ext-installed=\"\" data-new-gr-c-s-check-loaded=\"14.1025.0\">\n<p>Test Description</p>\n</body>\n<grammarly-desktop-integration data-grammarly-shadow-root=\"true\"></grammarly-desktop-integration></html>\n",
"notes": "",
"brand": "My Brand",
"brandLogo": "https://liveocxstorage.blob.core.windows.net/betterstore/logo/mybrand.png",
"brandId": 9664,
"brandRecordId": "fcf551c5-ccb5-4214-9b2b-ad5e003dc1a1",
"subBrand": "",
"subBrandId": "0",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£149.00",
"withoutTax": "£149.00",
"tax": "£33.01"
},
"raw": {
"withTax": 149,
"withoutTax": 149,
"tax": 33.01
}
},
"price": {
"minPrice": 115.99,
"minPriceWithoutTax": 115.99,
"maxPrice": 115.99,
"maxPriceWithoutTax": 115.99,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£115.99",
"withoutTax": "£115.99",
"tax": "£0.00"
},
"raw": {
"withTax": 115.99,
"withoutTax": 115.99,
"tax": 0
}
},
"attributeSet": null,
"uom": null,
"uomValue": "0",
"dimensions": null,
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/bundle_2.png?fm=webp",
"images": [
{
"name": "Image1",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/bundle_2.png?fm=webp",
"alt": null
}
],
"videos": null,
"pdFs": null,
"availability": 1,
"seoAvailability": "InStock",
"deliveryMessage": null,
"stockAvailabilityMessage": null,
"fulfilFromWarehouse": true,
"fulfilFromStore": false,
"fulfilFromSupplier": false,
"fulfilFromWarehouseDays": 4,
"fulfilFromSupplierDays": 0,
"fulfilFromInstoreDays": 0,
"currentStock": 87,
"rating": 0,
"displayTemplate": "",
"isDiscontinued": false,
"isVisible": true,
"breadCrumbs": [
{
"slugType": "Manufacturer",
"slug": {
"title": "My Brand",
"slug": "my-brand-url",
"childSlug": null
}
}
],
"classification": {
"categoryCode": "8e96d7ab-9695-4db3-add6-65ec8f7a3259",
"category": "DRESSES",
"itemTypeCode": null,
"itemType": "7",
"attributeSet": "Default Attribute set",
"attributeSetId": "227edf33-1894-43fe-acba-13c795c5c564",
"mainCategoryId": "8e96d7ab-9695-4db3-add6-65ec8f7a3259",
"mainCategoryName": "DRESSES"
},
"isGiftWrapApplied": false,
"giftWrapConfig": null,
"promotions": null,
"collections": null,
"flags": {
"sellWithoutInventory": false,
"isFreeDelivery": false
},
"preOrder": {
"shortMessage": "",
"message": "",
"currentStock": 0,
"maxStock": 0,
"isEnabled": false,
"launchDateTime": "1900-01-01T00:00:00"
},
"couponProvider": null,
"customAttributes": [],
"variantAttributes": null,
"variantProducts": [],
"reviews": null,
"relatedProducts": [
{
"productId": "11cc48f2-23eb-4579-8836-383a61ad2ea3",
"name": "Personalization",
"stockCode": "ADDON",
"relatedTypeCode": "ADDONS",
"relationDirectionCode": null,
"images": [
{
"name": "Image1",
"tag": null,
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/addon.jfif?fm=webp",
"imageTypes": null,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/products/addon.jfif?fm=webp",
"mobileUrl": null,
"alt": null,
"link": null,
"description": null,
"subTitle": null,
"linkType": null,
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": false,
"cssClass": null,
"title": null,
"displayOrder": 0,
"imageTags": []
}
],
"shortDescription": "<p>This is an add-on product for personalization.</p>\n",
"description": "<p>This is an add-on product for personalization.</p>\n",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/addon.jfif?fm=webp",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£0.00",
"withoutTax": "£0.00",
"tax": "£-1.99"
},
"raw": {
"withTax": 0,
"withoutTax": 0,
"tax": -1.99
}
},
"price": {
"minPrice": 1.99,
"minPriceWithoutTax": 1.99,
"maxPrice": 1.99,
"maxPriceWithoutTax": 1.99,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£1.99",
"withoutTax": "£1.99",
"tax": "£0.00"
},
"raw": {
"withTax": 1.99,
"withoutTax": 1.99,
"tax": 0
}
},
"slug": "products/my-brand-personalization-addon",
"currentStock": 9992,
"brand": "My Brand",
"subBrand": "",
"hasVariant": false,
"itemType": 10,
"sku": "ADDON"
}
],
"freeProducts": [],
"subscriptionEnabled": false,
"subscriptionPlanType": 0,
"componentProducts": [
{
"productId": "0a22f16c-2f5c-45b4-a5a0-38aa3eb93951",
"stockCode": "BS0010-DARK-ORANGE-S",
"qty": 1,
"name": "Cotton Racerback Spaghetti top for Women DARK ORANGE",
"slug": "products/my-brand-cotton-racerback-spaghetti-top-women-dark-orange-1-bs0010-dark-orange-s",
"brand": "My Brand",
"subBrand": "",
"shortDescription": "<p>Care Instructions: Care Instructions: Gentle Wash | Hand Wash | Do not Iron Directly<br />\nFabric: Cotton<br />\nFitting: Modern fit / Style : Racer back<br />\nPurpose : To be worn as lounge wear, leisure wear and Active wear - for all purpose use<br />\nLabel free for all day comfort<br />\nContoured armholes and neckline with delicate finish</p>\n",
"description": "<p>Care Instructions: Care Instructions: Gentle Wash | Hand Wash | Do not Iron Directly<br />\nFabric: Cotton<br />\nFitting: Modern fit / Style : Racer back<br />\nPurpose : To be worn as lounge wear, leisure wear and Active wear - for all purpose use<br />\nLabel free for all day comfort<br />\nContoured armholes and neckline with delicate finish</p>\n",
"images": [
{
"name": "Image1",
"tag": null,
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/orange1.jpg?fm=webp",
"imageTypes": null,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/products/orange1.jpg?fm=webp",
"mobileUrl": null,
"alt": null,
"link": null,
"description": null,
"subTitle": null,
"linkType": null,
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": false,
"cssClass": null,
"title": null,
"displayOrder": 0,
"imageTags": []
}
],
"image": null
}
],
"soldIndependently": true,
"componentsInStock": false,
"displayInBasket": true
},
"snippets": [
{
"name": "canishub_pdp",
"type": "Javascript",
"placement": "Head",
"content": "<script>\n\nwindow.addEventListener(\"load\",function(){\n var prodData = JSON.parse(dataLayer[0].entity);\n\tvar prodInfo = prodData.stockCode.split(\"-\")\n\tvar prodColor = prodInfo.slice(1,prodInfo.length-1).join('-');\n\tvar prodSize = prodInfo[prodInfo.length-1];\n\tvar itemId = prodInfo.slice(0,prodInfo.length-1).join('-');\n\n\n var prodData = JSON.parse(dataLayer[0].entity);\n let item = {\n item_id:itemId,\n title: prodData.name,\n sku: prodData.sku,\n categories: prodData.rootManufacturer, \t\t\t\n base_category:prodData.rootManufacturer, \t\n collection_name: '', \n description: prodData.name,\n product_url: getLiveUrl(window.location.href),\n image_url: prodData.img,\n condition: prodData.itemCondition,\n availability: prodData.availability,\n price: prodData.price.toFixed(2).toString(), \t\t\t\t\n sale_price: prodData.price.toFixed(2).toString(), \t\t\n brand: prodData.manufacturer,\n variant: {\n id: itemId,\n title: prodData.name,\n sku: prodData.sku,\n image_url:prodData.img,\n product_url: getLiveUrl(window.location.href), //getLiveUrl function is created in header snippet \n price: prodData.price.toFixed(2).toString(), \t\t\t\t\n sale_price:prodData.price.toFixed(2).toString(), \n availability: prodData.availability, \n metadata: {\n color: prodColor,\n size: prodSize,\n weight: 0,\n weight_unit: '',\n make: '',\n model: prodData.manufacturer,\n rating: 0\n }\n }\n };\n ch_pub_sub_events.publish('product_view_before', { 'item_id': item.item_id, 'item': item });\n\n},false);\n\n\n</script>",
"excludedUrl": null,
"microsites": [
"9413609e-635f-44ac-b697-ad5e00cd21dc",
]
}
],
"slugType": 1
}
Response : OK - with RelatedProducts
{
"statusCode": 200,
"status": "OK",
"errors": [],
"success": true,
"message": null,
"messageCode": null,
"result": {
"id": "5642870080",
"recordId": "f5b14610-33f6-4c45-bdd9-ad5e0048ca5c",
"productCode": "BS207933",
"stockCode": "BS207933-COBALT-L",
"barcode": "056428411394",
"name": "Colbalt Blue Embellished Flower Zip Through Hoodie",
"fullName": "My Brand Colbalt Blue Embellished Flower Zip Through Hoodie",
"seoName": "",
"metaTitle": "My Brand Colbalt Blue Embellished Flower Zip Through Hoodie | Betterstore",
"metaDescription": "Buy My Brand Colbalt Blue Embellished Flower Zip Through Hoodie online at Betterstore. Next-day delivery is available.",
"metaKeywords": "My Brand Colbalt Blue Embellished Flower Zip Through Hoodie | Betterstore",
"canonicalTags": "",
"link": "products/my-brand-colbalt-blue-embellished-flower-zip-through-hoodie-bs207933-cobalt-l",
"shortDescription": "",
"description": "<p>Comfort meets glamour this season with our Cobalt Blue Embellished Flower Zip Through Hoodie. The cuffed sleeves and drawstring hood provide the ultimate in comfort whilst the jewelled flower detail on the shoulders adds a dash of glam. Pair with our matching Colbat Blue Embellished Flower Jogger for a co-ord set that is simply perfect for those off duty days.</p>\n\n<p><em>Also available in grey, black and pink.</em></p>\n\n<p><strong>DETAILS</strong></p>\n\n<ul>\n\t<li>Zip Up Fastening</li>\n\t<li>Jewelled Flower Embellishment</li>\n\t<li>Drawstring Hood</li>\n\t<li>Cuffed Sleeves</li>\n</ul>\n\n<p><strong>SIZE AND FIT</strong></p>\n\n<p>Model wears size S (UK 8/10)</p>\n\n<p>(M= UK 12/14 L= UK 16/18)</p>\n\n<p><strong>LOOK AFTER ME</strong></p>\n\n<p>Hand wash only</p>\n\n<p>Do not bleach</p>\n\n<p>Do not dry clean</p>\n\n<p>Cool iron on reverse</p>\n\n<p>Do not dry clean</p>\n\n<p><strong>MATERIAL</strong></p>\n\n<p>100% Cotton</p>\n ",
"notes": "",
"brand": "My Brand",
"brandLogo": "https://liveocxstorage.blob.core.windows.net/betterstore/logo/mybrand.png",
"brandId": 9664,
"brandRecordId": "fcf551c5-ccb5-4214-9b2b-ad5e003dc1a1",
"subBrand": "",
"subBrandId": "0",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£49.99",
"withoutTax": "£49.99",
"tax": "£19.99"
},
"raw": {
"withTax": 49.99,
"withoutTax": 49.99,
"tax": 19.99
}
},
"price": {
"minPrice": 30,
"minPriceWithoutTax": 30,
"maxPrice": 30,
"maxPriceWithoutTax": 30,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£30.00",
"withoutTax": "£30.00",
"tax": "£0.00"
},
"raw": {
"withTax": 30,
"withoutTax": 30,
"tax": 0
}
},
"attributeSet": null,
"uom": "",
"uomValue": "0",
"dimensions": null,
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/uar207933_blue_07313.webp?fm=webp",
"images": [
{
"name": "Image1",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/uar207933_blue_07313.webp?fm=webp",
"alt": "Colbalt Blue Embellished Flower Zip Through Hoodie"
}
],
"videos": null,
"pdFs": null,
"availability": 2,
"seoAvailability": "OutOfStock",
"deliveryMessage": null,
"stockAvailabilityMessage": null,
"fulfilFromWarehouse": false,
"fulfilFromStore": false,
"fulfilFromSupplier"