Collection
Collection contains a group of linked internet addresses which may or may not contain various categories of the entities e.g. Men's Collection, Women's Collection, etc. On this page, we'll dive into the different Collection endpoints you can use to manage all your Categories programmatically.
Get all product collections
This endpoint allows you to retrieve a list of all the Collections defined.
Developers - API Operations:
Operation | Endpoint | Response |
---|---|---|
All Product Collection | /api/v2/catalog/collection/all | Get all the Collection. |
Response Properties
- 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 Collection
- Name
name
- Type
- string
- Description
Name of the Collection
- Name
slug
- Type
- string
- Description
Link associated with each Collection
- Name
dataSource
- Type
- string
- Description
Data source of Image
- Name
ruleType
- Type
- string
- Description
Type of rule implemented in Collection
- Name
noOfRecords
- Type
- array
- Description
Array containing list of records
- Name
sortBy
- Type
- string
- Description
Parameter to sort-by.
- Name
products
- Type
- array
- Description
List of the products in the collection
- Name
brands
- Type
- array
- Description
Contains the brands for each collection
- Name
subBrands
- Type
- array
- Description
Contains the subBrands of each Brands
- 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
langCulture
- Type
- string
- Description
Language associated with the product
- Name
snippets
- Type
- array
- Description
Array containing additional code pieces to be added with the category
Request
curl --location --request GET 'https://api20.bettercommerce.io/api/v2/catalog/collection/all' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'
Response
{
"statusCode": 200,
"status": "OK",
"errors": [],
"success": true,
"message": null,
"messageCode": null,
"result": [
{
"id": "21cc9b24-d208-4c7b-aa37-ad5f009184a1",
"name": "Specially Curated",
"slug": "",
"dataSource": 1,
"ruleType": 0,
"noOfRecords": 50,
"sortBy": 0,
"products": null,
"brands": null,
"subBrands": null,
"metaTitle": null,
"metaDescription": null,
"metaKeywords": null,
"canonicalTags": null,
"link": null,
"mainImage": ""
}
]
}
Get product collection data based on collection Id
This endpoint retrieves a collection based on the Id passed.
Developers - API Operations:
Operation | Endpoint | Response |
---|---|---|
All Product Collection by Id | /api/v2/catalog/collection/id/:id | Get all the Collection by Id. |
Required attributes
- Name
id
- Type
- string
- Description
Unique id for each Collection.
Response Properties
- 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 Collection
- Name
name
- Type
- string
- Description
Name of the Collection
- Name
listType
- Type
- string
- Description
Type of the List
- Name
products
- Type
- array
- Description
List of the products in the collection
- Name
pages
- Type
- number
- Description
Pages in the Collection.
- Name
currentPage
- Type
- number
- Description
Current Pages in the Response.
- Name
prevPageUrl
- Type
- number
- Description
The URL of the Previous Page.
- Name
nextPageUrl
- Type
- number
- Description
The URL of the Next Page.
- Name
sortList
- Type
- array
- Description
Array to sort in the List.
- Name
sortBy
- Type
- string
- Description
Parameter to sort-by.
- Name
images
- Type
- array
- Description
Array of Images.
- Name
image
- Type
- string
- Description
URL of the product image
- 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
- boolean
- 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
seoName
- Type
- string
- Description
SEO Name
- 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
fieldName
- Type
- string
- Description
Name of the field
- Name
fieldCode
- Type
- string
- Description
Unique Code corresponding to the field
- Name
inputType
- Type
- string
- Description
Defines the Input type of the attribute
- Name
stockCode
- Type
- string
- Description
Unique id of the stock
- Name
productId
- Type
- string
- Description
Unique id of the Product
- Name
fieldValue
- Type
- number
- Description
Unique code of the Field
- Name
independentProductUrl
- Type
- string
- Description
independent Url of the product
- Name
displayInProductWidget
- Type
- boolean
- Description
Display in product widget
- Name
inputType
- Type
- string
- Description
Name of the field
- Name
stockCode
- Type
- string
- Description
Unique id of the stock
- Name
productId
- Type
- string
- Description
Unique id of the Product
- Name
fieldValue
- Type
- number
- Description
Unique code of the Field
- 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
ProductName
- Type
- string
- Description
Price of the product to be sold
- Name
isPreOrderEnabled
- Type
- boolean
- Description
Flag to check is preOrder enabled or not
- Name
isVisible
- Type
- boolean
- Description
Flag to check is visible enabled or not
- Name
variantInputType
- Type
- string
- Description
Input type of the variant
- Name
relatedProducts
- Type
- array
- Description
Array of objects containing related products
- 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
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
variantProducts
- Type
- array
- Description
Array of objects containing variant products for each variant
- Name
fieldValues
- Type
- string
- Description
Contains value of the field
- Name
subscriptionEnabled
- Type
- boolean
- Description
Flag to check is subscription enabled or not
- Name
displayTemplate
- Type
- string
- Description
Template for display of attribute
- Name
brandLogo
- Type
- string
- Description
Logo of the brand
- 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
recordId
- Type
- string
- Description
Id of the Brand Record
- Name
itemType
- Type
- string
- Description
Type of the item
- Name
shortDescription
- Type
- string
- Description
Short description of the product
- Name
subscriptionPlanType
- Type
- string
- Description
Type of the subscription plan
- Name
subscriptionPlanType
- Type
- string
- Description
Type of the subscription plan
- Name
brand
- Type
- string
- Description
Name of the brand
- Name
brandSlug
- Type
- string
- Description
Slug of the brand
- Name
subBrand
- Type
- string
- Description
SubBrand of parent Brand
- Name
categoryId
- Type
- string
- Description
Category Id
- Name
categoryCode
- Type
- string
- Description
Category Code
- Name
mainCategoryId
- Type
- string
- Description
Main category Id
- Name
category
- Type
- string
- Description
Category of the product
- Name
itemTypeCode
- Type
- string
- Description
Code for the itemType
- 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
productId
- Type
- string
- Description
Unique id of the Product
- Name
productName
- Type
- string
- Description
Name of the Product
- Name
variantAttributes
- Type
- array
- Description
Array containing information about the variant attributes for the product
- Name
fieldCode
- Type
- string
- Description
Unique Code corresponding to the field
- Name
inputType
- Type
- string
- Description
Defines the Input type of the attribute
- Name
fieldValue
- Type
- string
- Description
Unique code of the Field
- Name
variantProductsAttributeMinimal
- Type
- array
- Description
Minimal variant products attribute array
- Name
fieldName
- Type
- string
- Description
Name of the field
- 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
- Name
filters
- Type
- array
- Description
Filters to be applied
- Name
groups
- Type
- array
- Description
Groups where the product belongs
- Name
subBrands
- Type
- array
- Description
Contains the subBrands of each Brands
- Name
categories
- Type
- array
- Description
Contains the categories
- Name
subcategories
- Type
- array
- Description
Contains the subcategories of each category
- Name
blogs
- Type
- array
- Description
Contains the blogs of each category
- Name
allowFacets
- Type
- boolean
- Description
Flag to check Is allowFacets true or not
- Name
filterCriteria
- Type
- string
- Description
Criteria for filtering
- Name
pageSize
- Type
- string
- Description
Size of the page
- Name
displayTitle
- Type
- boolean
- Description
Flag to allow title to be displayed or not
- Name
customInfo1
- Type
- array
- Description
Array containing customInfo1 values
- Name
customInfo2
- Type
- array
- Description
Array containing customInfo2 values
- Name
customInfo3
- Type
- array
- Description
Array containing customInfo3 values
- Name
customFieldValue
- Type
- string
- Description
String containing customFieldValue
- Name
customFieldDisplayOrder
- Type
- string
- Description
String containing customFieldDisplayOrder
- Name
mainImage
- Type
- string
- Description
Main Image Url of the Product
- Name
image1
- Type
- string
- Description
Image1 Url of the Product
- Name
image2
- Type
- string
- Description
Image2 Url of the Product
- Name
image3
- Type
- string
- Description
Image3 Url of the Product
- Name
image4
- Type
- string
- Description
Image4 Url of the Product
- Name
displayGroupName
- Type
- string
- Description
Image4 Url of the Product
- Name
imageBy
- Type
- string
- Description
Image source title
- Name
createdBy
- Type
- string
- Description
Product created by
- Name
customLinks
- Type
- string
- Description
Custom links for the product
- Name
snippets
- Type
- array
- Description
Array containing additional code pieces to be added with the category
- Name
content
- Type
- string
- Description
Content of the each snippet added
- Name
placement
- Type
- string
- Description
Placement of the each snippet added
- Name
excludedUrl
- Type
- string
- Description
Excluded Url for each snippet added
- Name
microsites
- Type
- array
- Description
Array containing list of microsites
Request
curl --location --request GET 'https://api20.bettercommerce.io/api/v2/catalog/collection/id/07a708cf-fc1a-417c-b9a3-adbf0083d45d' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'
Response
{
"statusCode": 200,
"status": "OK",
"errors": [],
"success": true,
"message": null,
"messageCode": null,
"result": {
"id": "07a708cf-fc1a-417c-b9a3-adbf0083d45d",
"name": "Coats and Jackets",
"listType": 0,
"products": {
"total": 17,
"pages": 1,
"currentPage": 1,
"prevPageUrl": null,
"nextPageUrl": null,
"sortList": [
{
"key": "1",
"value": "Price : low to high"
}
],
"sortBy": "1",
"images": [
{
"name": "",
"tag": null,
"image": "midbanner/download1.jfif",
"imageTypes": 5,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/midbanner/download1.jfif",
"mobileUrl": "",
"id": null,
"alt": "",
"link": "",
"description": "",
"subTitle": null,
"linkType": "1",
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": true,
"cssClass": null,
"segment": "",
"title": "",
"displayOrder": 0,
"data": null,
"imageTags": null
}
]
"results": [
{
"id": "5642869902",
"seoName": "",
"barcode": null,
"isFeatured": false,
"uom": "",
"uomValue": 0,
"variant": {
"variantInputType": 2,
"listType": 1,
"independentProductUrl": false,
"displayInProductWidget": true,
"displayInProductDetail": true,
"attributes": [
{
"fieldName": "Size",
"fieldCode": "clothing.size",
"inputType": null,
"products": [
{
"stockCode": "BS21397-TAN-SM",
"barCode": "056428402304",
"productId": "086bc1c5-d3e7-42b7-9641-ad5e0048ca5b",
"isDefault": false,
"fieldValue": "sm",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex21397_camel_2717.webp?fm=webp",
"fieldLabel": "",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£39.99",
"withoutTax": "£39.99",
"tax": "£29.99"
},
"raw": {
"withTax": 39.99,
"withoutTax": 39.99,
"tax": 29.99
}
},
"sellPrice": {
"minPrice": 10,
"minPriceWithoutTax": 10,
"maxPrice": 10,
"maxPriceWithoutTax": 10,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£10.00",
"withoutTax": "£10.00",
"tax": "£0.00"
},
"raw": {
"withTax": 10,
"withoutTax": 10,
"tax": 0
}
},
"productName": "Tan Roll Neck Knitted Jumper With Puff Sleeve",
"slug": "products/my-brand-tan-roll-neck-knitted-jumper-with-puff-sleeve-bs21397-tan-onesize",
"defaultForFrontend": false,
"sellWithoutInventory": false,
"currentStock": 0,
"isPreOrderEnabled": false,
"enableNotifyMe": false,
"isActive": false,
"isVisible": false,
"description": null
},
]
}
],
"variantInputTypes": ""
},
"attributeSet": null,
"relatedProducts": [],
"displayOrder": 0,
"metaTitle": "",
"metaDescription": "",
"metaKeywords": null,
"canonicalTags": null,
"flags": {
"isFreeDelivery": false,
"sellWithoutInventory": false
},
"isDiscontinued": false,
"freeProducts": [],
"link": null,
"componentProducts": null,
"componentsInStock": false,
"variantProducts": [
{
"stockCode": "BS21397-TAN-SM",
"productId": "086bc1c5-d3e7-42b7-9641-ad5e0048ca5b",
"slug": "products/my-brand-tan-roll-neck-knitted-jumper-with-puff-sleeve-bs21397-tan-onesize",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex21397_camel_2717.webp?fm=webp",
"productName": "Tan Roll Neck Knitted Jumper With Puff Sleeve",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£39.99",
"withoutTax": "£39.99",
"tax": "£29.99"
},
"raw": {
"withTax": 39.99,
"withoutTax": 39.99,
"tax": 29.99
}
},
"price": {
"minPrice": 10,
"minPriceWithoutTax": 10,
"maxPrice": 10,
"maxPriceWithoutTax": 10,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£10.00",
"withoutTax": "£10.00",
"tax": "£0.00"
},
"raw": {
"withTax": 10,
"withoutTax": 10,
"tax": 0
}
},
"isDefault": false,
"isPreOrderEnabled": false,
"sellWithoutInventory": false,
"currentStock": 0,
"description": null,
"attributes": [
{
"fieldCode": "clothing.size",
"fieldName": "Size",
"fieldValue": "sm",
"fieldLabel": ""
},
{
"fieldCode": "global.colour",
"fieldName": "Colour",
"fieldValue": "#d2b48c",
"fieldLabel": ""
}
]
}
],
"variantProductsAttribute": [
{
"fieldName": "Size",
"fieldCode": "clothing.size",
"fieldLabel": null,
"inputType": null,
"fieldValues": [
{
"fieldValue": "sm",
"fieldLabel": null
}
],
"independentProductUrl": false,
"displayInProductDetail": true,
"displayInProductWidget": true
}
],
"subscriptionEnabled": false,
"minPrice": null,
"maxPrice": null,
"displayTemplate": "",
"brandLogo": "https://liveocxstorage.blob.core.windows.net/betterstore/logo/mybrand.png",
"attributes": [
{
"key": "global.colour",
"customkey": "global.colour~#d2b48c~Colour",
"display": "Colour",
"value": "#d2b48c",
"originalValue": null,
"isVariantAttribute": false,
"displayInProductDetail": false,
"displayInProductList": true,
"groupDisplayOrder": 0
}
],
"recordId": "da9e87ee-8e1a-4abc-a83e-ad5e0048ca5b",
"name": "Tan Roll Neck Knitted Jumper With Puff Sleeve",
"slug": "products/my-brand-tan-roll-neck-knitted-jumper-with-puff-sleeve-bs21397-tan-onesize",
"stockCode": "BS21397-TAN-ONESIZE",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£39.99",
"withoutTax": "£39.99",
"tax": "£29.99"
},
"raw": {
"withTax": 39.99,
"withoutTax": 39.99,
"tax": 29.99
}
},
"price": {
"minPrice": 10,
"minPriceWithoutTax": 10,
"maxPrice": 10,
"maxPriceWithoutTax": 10,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£10.00",
"withoutTax": "£10.00",
"tax": "£0.00"
},
"raw": {
"withTax": 10,
"withoutTax": 10,
"tax": 0
}
},
"images": [
{
"name": "Image1",
"tag": "Tan Roll Neck Knitted Jumper With Puff Sleeve",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex21397_camel_2717.webp?fm=webp",
"imageTypes": null,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/ex21397_camel_2717.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": []
}
],
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex21397_camel_2717.webp?fm=webp",
"itemType": 1,
"shortDescription": "",
"subscriptionPlanType": 0,
"groupName": null,
"brand": "My Brand",
"brandSlug": null,
"subBrand": "",
"sku": "BS21397",
"priceFrom": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": ",",
"currencyDigitsAfterDecimal": 3,
"currencySymbol": "£",
"formatted": {
"withTax": "£10.00",
"withoutTax": "£10.00",
"tax": "£0.00"
},
"raw": {
"withTax": 10,
"withoutTax": 10,
"tax": 0
}
},
"classification": {
"categoryId": "964f0baf-3f63-4e57-866b-bbe0cb494694",
"categoryCode": "964f0baf-3f63-4e57-866b-bbe0cb494694",
"mainCategoryId": "6e3252f0-b8d5-473e-8b1f-60b62d82b5d5",
"mainCategoryName": "KNITWEAR",
"category": "JUMPERS",
"itemTypeCode": null,
"itemType": "1",
"attributeSet": "Default Attribute set",
"attributeSetId": "227edf33-1894-43fe-acba-13c795c5c564"
},
"currentStock": 91651,
"description": "<p>Weather's getting cold outside? No problem when you have our Tan Roll Neck Knitted Jumper With Puff Sleeve. With flattering gathered sleeves, puff shoulders and a roll neckline, you can stay warm whilst still maintaining style. Pair with leather trousers or your favourite pair of jeans and you're ready to battle the cold weather. </p>\n\n<p><em>Also available in Black</em></p>\n\n<p>One size fits UK size 8-12</p>\n\n<p><strong>DETAILS</strong></p>\n\n<ul>\n\t<li>\n\t<p>Extreme puffed sleeves </p>\n\t</li>\n\t<li>\n\t<p>Roll neck </p>\n\t</li>\n\t<li>\n\t<p>Ribbed knit material</p>\n\t</li>\n\t<li>\n\t<p>Long sleeves </p>\n\t</li>\n</ul>\n\n<p> </p>\n\n<p><strong>SIZE & FIT</strong></p>\n\n<p>Lulu wears ONESIZE (approximately UK 8-12 depending on desired fit)</p>\n\n<p>Model height 5”9</p>\n\n<p> </p>\n\n<p><strong>LOOK AFTER ME</strong></p>\n\n<p>Wash at 30 degrees</p>\n\n<p>Iron on low </p>\n\n<p>Do not tumble dry </p>\n\n<p> </p>\n\n<p><strong>MATERIAL</strong></p>\n\n<p>100% Acrylic</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": false,
"hasVariant": true,
"promotions": null,
"preOrder": {
"isEnabled": false,
"launchDateTime": "1900-01-01T00:00:00"
}
},
],
"filters": [],
"groups": null
},
"brands": null,
"subBrands": null,
"categories": null,
"subCategories": null,
"images": [
{
"name": "",
"tag": null,
"image": "midbanner/download1.jfif",
"imageTypes": 5,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/midbanner/download1.jfif",
"mobileUrl": "",
"alt": "",
"link": "",
"description": "",
"subTitle": null,
"linkType": "1",
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": true,
"cssClass": null,
"title": "",
"displayOrder": 0,
"imageTags": []
}
],
"blogs": null,
"metaTitle": null,
"metaDescription": null,
"metaKeywords": null,
"canonicalTags": null,
"allowFacets": false,
"filters": null,
"filterCriteria": null,
"pageSize": 0,
"sortBy": null,
"link": "coats-and-jackets",
"groupSeparator": null,
"groupCode": null,
"displayTitle": false,
"groups": null,
"customInfo1": null,
"customInfo2": null,
"customInfo3": null,
"customFieldValue": null,
"customFieldDisplayOrder": null,
"description": "",
"mainImage": "",
"image1": null,
"image2": null,
"image3": null,
"image4": null,
"imageAnnotationsJson": null,
"imageAnnotationsJson1": null,
"imageAnnotationsJson2": null,
"imageAnnotationsJson3": null,
"imageAnnotationsJson4": null,
"displayGroupName": "",
"imageBy": 1,
"createdBy": "example@mail.com",
"customLinks": null,
"categoryId": 0
}
}
Get product collection data based on collection Slug
This endpoint retrieves a collection based on the Slug passed.
Developers - API Operations:
Operation | Endpoint | Response |
---|---|---|
All Product Collection by Slug | /api/v2/catalog/collection/slug?slug={{slug}} | Get all the Collection by Slug. |
Required attributes
- Name
slug
- Type
- string
- Description
Unique slug for each Collection.
Response Properties
- 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 Collection
- Name
name
- Type
- string
- Description
Name of the Collection
- Name
listType
- Type
- string
- Description
Type of the List
- Name
products
- Type
- array
- Description
List of the products in the collection
- Name
slug
- Type
- string
- Description
Unique slug for each Category.
- Name
pages
- Type
- number
- Description
Pages in the Collection.
- Name
currentPage
- Type
- number
- Description
Current Pages in the Response.
- Name
prevPageUrl
- Type
- number
- Description
The URL of the Previous Page.
- Name
nextPageUrl
- Type
- number
- Description
The URL of the Next Page.
- Name
sortList
- Type
- array
- Description
Array to sort in the List.
- Name
sortBy
- Type
- string
- Description
Parameter to sort-by.
- Name
images
- Type
- array
- Description
Array of Images.
- Name
image
- Type
- string
- Description
URL of the product image
- 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
title
- Type
- string
- Description
title of the image
- Name
seoName
- Type
- string
- Description
SEO Name
- 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
fieldName
- Type
- string
- Description
Name of the field
- Name
fieldCode
- Type
- string
- Description
Unique Code corresponding to the field
- Name
inputType
- Type
- string
- Description
Defines the Input type of the attribute
- Name
stockCode
- Type
- string
- Description
Unique id of the stock
- Name
productId
- Type
- string
- Description
Unique id of the Product
- Name
fieldValue
- Type
- number
- Description
Unique code of the Field
- Name
independentProductUrl
- Type
- string
- Description
independent Url of the product
- Name
displayInProductWidget
- Type
- boolean
- Description
Display in product widget
- Name
fieldName
- Type
- string
- Description
Name of the field
- Name
fieldCode
- Type
- string
- Description
Unique Code corresponding to the field
- Name
inputType
- Type
- string
- Description
Defines the Input type of the attribute
- Name
stockCode
- Type
- string
- Description
Unique id of the stock
- Name
productId
- Type
- string
- Description
Unique id of the Product
- Name
isDefault
- Type
- boolean
- Description
Flag to check is attribute default or not
- Name
fieldValue
- Type
- number
- Description
Unique code of the Field
- 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
currencySymbol
- Type
- string
- Description
Symbol of 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
ProductName
- Type
- string
- Description
Price of the product to be sold
- Name
isPreOrderEnabled
- Type
- boolean
- Description
Flag to check is preOrder enabled or not
- Name
isVisible
- Type
- boolean
- Description
Flag to check is visible enabled or not
- Name
variantInputType
- Type
- string
- Description
Input type of the variant
- Name
relatedProducts
- Type
- array
- Description
Array of objects containing related products
- 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
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
fieldValues
- Type
- string
- Description
Contains value of the field
- Name
subscriptionEnabled
- Type
- boolean
- Description
Flag to check is subscription enabled or not
- Name
displayTemplate
- Type
- string
- Description
Template for display of attribute
- Name
brandLogo
- Type
- string
- Description
Logo of the brand
- 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
recordId
- Type
- string
- Description
Id of the Brand Record
- Name
displayInProductList
- Type
- boolean
- Description
Flag to check display in product list
- Name
groupDisplayOrder
- Type
- number
- Description
Order of the group display
- Name
itemType
- Type
- string
- Description
Type of the item
- Name
shortDescription
- Type
- string
- Description
Short description of the product
- Name
subscriptionPlanType
- Type
- string
- Description
Type of the subscription plan
- Name
brand
- Type
- string
- Description
Name of the brand
- Name
brandSlug
- Type
- string
- Description
Slug of the brand
- Name
subBrand
- Type
- string
- Description
SubBrand of parent Brand
- Name
categoryId
- Type
- string
- Description
Category Id
- Name
categoryCode
- Type
- string
- Description
Category Code
- Name
mainCategoryId
- Type
- string
- Description
Main category Id
- Name
category
- Type
- string
- Description
Category of the product
- Name
itemTypeCode
- Type
- string
- Description
Code for the itemType
- 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
- Name
filters
- Type
- array
- Description
Filters to be applied
- Name
groups
- Type
- array
- Description
Groups where the product belongs
- Name
subBrands
- Type
- array
- Description
Contains the subBrands of each Brands
- Name
categories
- Type
- array
- Description
Contains the categories
- Name
subcategories
- Type
- array
- Description
Contains the subcategories of each category
- Name
blogs
- Type
- array
- Description
Contains the blogs of each category
- Name
allowFacets
- Type
- boolean
- Description
Flag to check Is allowFacets true or not
- Name
filterCriteria
- Type
- string
- Description
Criteria for filtering
- Name
pageSize
- Type
- string
- Description
Size of the page
- Name
displayTitle
- Type
- boolean
- Description
Flag to allow title to be displayed or not
- Name
customInfo1
- Type
- array
- Description
Array containing customInfo1 values
- Name
customInfo2
- Type
- array
- Description
Array containing customInfo2 values
- Name
customInfo3
- Type
- array
- Description
Array containing customInfo3 values
- Name
customFieldValue
- Type
- string
- Description
String containing customFieldValue
- Name
customFieldDisplayOrder
- Type
- string
- Description
String containing customFieldDisplayOrder
- Name
mainImage
- Type
- string
- Description
Main Image Url of the Product
- Name
image1
- Type
- string
- Description
Image1 Url of the Product
- Name
image2
- Type
- string
- Description
Image2 Url of the Product
- Name
image3
- Type
- string
- Description
Image3 Url of the Product
- Name
image4
- Type
- string
- Description
Image4 Url of the Product
- Name
displayGroupName
- Type
- string
- Description
Image4 Url of the Product
- Name
imageBy
- Type
- string
- Description
Image source title
- Name
createdBy
- Type
- string
- Description
Product created by
- Name
customLinks
- Type
- string
- Description
Custom links for the product
- Name
snippets
- Type
- array
- Description
Array containing additional code pieces to be added with the category
- Name
content
- Type
- string
- Description
Content of the each snippet added
- Name
placement
- Type
- string
- Description
Placement of the each snippet added
- Name
excludedUrl
- Type
- string
- Description
Excluded Url for each snippet added
- Name
microsites
- Type
- array
- Description
Array containing list of microsites
Request
curl --location --request POST 'https://api20.bettercommerce.io/api/v2/catalog/collection/slug?slug=coats-and-jackets' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'
Response
{
"statusCode": 200,
"status": "OK",
"errors": [],
"success": true,
"message": null,
"messageCode": null,
"result": {
"id": "07a708cf-fc1a-417c-b9a3-adbf0083d45d",
"name": "Coats and Jackets",
"listType": 1,
"products": {
"total": 17,
"pages": 1,
"currentPage": 1,
"prevPageUrl": null,
"nextPageUrl": null,
"sortList": [
{
"key": "1",
"value": "Price : low to high"
}
],
"sortBy": "1",
"images": [
{
"name": "",
"tag": null,
"image": "midbanner/download1.jfif",
"imageTypes": 5,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/midbanner/download1.jfif",
"mobileUrl": "",
"id": null,
"alt": "",
"link": "",
"description": "",
"subTitle": null,
"linkType": "1",
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": true,
"cssClass": null,
"segment": "",
"title": "",
"displayOrder": 0,
"data": null,
"imageTags": null
}
],
"results": [
{
"id": "5642869902",
"seoName": "",
"barcode": null,
"isFeatured": false,
"uom": "",
"uomValue": 0,
"variant": {
"variantInputType": 2,
"listType": 1,
"independentProductUrl": false,
"displayInProductWidget": true,
"displayInProductDetail": true,
"attributes": [
{
"fieldName": "Size",
"fieldCode": "clothing.size",
"inputType": null,
"products": [
{
"stockCode": "BS21397-TAN-SM",
"barCode": "056428402304",
"productId": "086bc1c5-d3e7-42b7-9641-ad5e0048ca5b",
"isDefault": false,
"fieldValue": "sm",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex21397_camel_2717.webp?fm=webp",
"fieldLabel": "",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£39.99",
"withoutTax": "£39.99",
"tax": "£29.99"
},
"raw": {
"withTax": 39.99,
"withoutTax": 39.99,
"tax": 29.99
}
},
"sellPrice": {
"minPrice": 10,
"minPriceWithoutTax": 10,
"maxPrice": 10,
"maxPriceWithoutTax": 10,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£10.00",
"withoutTax": "£10.00",
"tax": "£0.00"
},
"raw": {
"withTax": 10,
"withoutTax": 10,
"tax": 0
}
},
"productName": "Tan Roll Neck Knitted Jumper With Puff Sleeve",
"slug": "products/my-brand-tan-roll-neck-knitted-jumper-with-puff-sleeve-bs21397-tan-onesize",
"defaultForFrontend": false,
"sellWithoutInventory": false,
"currentStock": 0,
"isPreOrderEnabled": false,
"enableNotifyMe": false,
"isActive": false,
"isVisible": false,
"description": null
}
]
}
],
"variantInputTypes": ""
},
"attributeSet": null,
"relatedProducts": [],
"displayOrder": 1000,
"metaTitle": "",
"metaDescription": "",
"metaKeywords": null,
"canonicalTags": null,
"flags": {
"isFreeDelivery": false,
"sellWithoutInventory": false
},
"isDiscontinued": false,
"freeProducts": [],
"link": null,
"componentProducts": null,
"componentsInStock": false,
"variantProducts": [
{
"stockCode": "BS21397-TAN-SM",
"productId": "086bc1c5-d3e7-42b7-9641-ad5e0048ca5b",
"slug": "products/my-brand-tan-roll-neck-knitted-jumper-with-puff-sleeve-bs21397-tan-onesize",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex21397_camel_2717.webp?fm=webp",
"productName": "Tan Roll Neck Knitted Jumper With Puff Sleeve",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£39.99",
"withoutTax": "£39.99",
"tax": "£29.99"
},
"raw": {
"withTax": 39.99,
"withoutTax": 39.99,
"tax": 29.99
}
},
"price": {
"minPrice": 10,
"minPriceWithoutTax": 10,
"maxPrice": 10,
"maxPriceWithoutTax": 10,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£10.00",
"withoutTax": "£10.00",
"tax": "£0.00"
},
"raw": {
"withTax": 10,
"withoutTax": 10,
"tax": 0
}
},
"isDefault": false,
"isPreOrderEnabled": false,
"sellWithoutInventory": false,
"currentStock": 0,
"description": null,
"attributes": [
{
"fieldCode": "clothing.size",
"fieldName": "Size",
"fieldValue": "sm",
"fieldLabel": ""
}
]
}
],
"variantProductsAttribute": [
{
"fieldName": "Size",
"fieldCode": "clothing.size",
"fieldLabel": null,
"inputType": null,
"fieldValues": [
{
"fieldValue": "sm",
"fieldLabel": null
}
],
"independentProductUrl": false,
"displayInProductDetail": true,
"displayInProductWidget": true
}
],
"subscriptionEnabled": false,
"minPrice": null,
"maxPrice": null,
"displayTemplate": "",
"brandLogo": "https://liveocxstorage.blob.core.windows.net/betterstore/logo/mybrand.png",
"attributes": [
{
"key": "global.colour",
"customkey": "global.colour~#d2b48c~Colour",
"display": "Colour",
"value": "#d2b48c",
"originalValue": null,
"isVariantAttribute": false,
"displayInProductDetail": false,
"displayInProductList": true,
"groupDisplayOrder": 0
}
],
"recordId": "da9e87ee-8e1a-4abc-a83e-ad5e0048ca5b",
"name": "Tan Roll Neck Knitted Jumper With Puff Sleeve",
"slug": "products/my-brand-tan-roll-neck-knitted-jumper-with-puff-sleeve-bs21397-tan-onesize",
"stockCode": "BS21397-TAN-ONESIZE",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£39.99",
"withoutTax": "£39.99",
"tax": "£29.99"
},
"raw": {
"withTax": 39.99,
"withoutTax": 39.99,
"tax": 29.99
}
},
"price": {
"minPrice": 10,
"minPriceWithoutTax": 10,
"maxPrice": 10,
"maxPriceWithoutTax": 10,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£10.00",
"withoutTax": "£10.00",
"tax": "£0.00"
},
"raw": {
"withTax": 10,
"withoutTax": 10,
"tax": 0
}
},
"images": [
{
"name": "Image1",
"tag": "Tan Roll Neck Knitted Jumper With Puff Sleeve",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex21397_camel_2717.webp?fm=webp",
"imageTypes": null,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/ex21397_camel_2717.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": []
}
],
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex21397_camel_2717.webp?fm=webp",
"itemType": 1,
"shortDescription": "",
"subscriptionPlanType": 0,
"groupName": null,
"brand": "My Brand",
"brandSlug": null,
"subBrand": "",
"sku": "BS21397",
"priceFrom": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": ",",
"currencyDigitsAfterDecimal": 3,
"currencySymbol": "£",
"formatted": {
"withTax": "£10.00",
"withoutTax": "£10.00",
"tax": "£0.00"
},
"raw": {
"withTax": 10,
"withoutTax": 10,
"tax": 0
}
},
"classification": {
"categoryId": "964f0baf-3f63-4e57-866b-bbe0cb494694",
"categoryCode": "964f0baf-3f63-4e57-866b-bbe0cb494694",
"mainCategoryId": "6e3252f0-b8d5-473e-8b1f-60b62d82b5d5",
"mainCategoryName": "KNITWEAR",
"category": "JUMPERS",
"itemTypeCode": null,
"itemType": "1",
"attributeSet": "Default Attribute set",
"attributeSetId": "227edf33-1894-43fe-acba-13c795c5c564"
},
"currentStock": 91651,
"description": "<p>Weather's getting cold outside? No problem when you have our Tan Roll Neck Knitted Jumper With Puff Sleeve. With flattering gathered sleeves, puff shoulders and a roll neckline, you can stay warm whilst still maintaining style. Pair with leather trousers or your favourite pair of jeans and you're ready to battle the cold weather. </p>\n\n<p><em>Also available in Black</em></p>\n\n<p>One size fits UK size 8-12</p>\n\n<p><strong>DETAILS</strong></p>\n\n<ul>\n\t<li>\n\t<p>Extreme puffed sleeves </p>\n\t</li>\n\t<li>\n\t<p>Roll neck </p>\n\t</li>\n\t<li>\n\t<p>Ribbed knit material</p>\n\t</li>\n\t<li>\n\t<p>Long sleeves </p>\n\t</li>\n</ul>\n\n<p> </p>\n\n<p><strong>SIZE & FIT</strong></p>\n\n<p>Lulu wears ONESIZE (approximately UK 8-12 depending on desired fit)</p>\n\n<p>Model height 5”9</p>\n\n<p> </p>\n\n<p><strong>LOOK AFTER ME</strong></p>\n\n<p>Wash at 30 degrees</p>\n\n<p>Iron on low </p>\n\n<p>Do not tumble dry </p>\n\n<p> </p>\n\n<p><strong>MATERIAL</strong></p>\n\n<p>100% Acrylic</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": false,
"hasVariant": true,
"promotions": null,
"preOrder": {
"isEnabled": false,
"launchDateTime": "1900-01-01T00:00:00"
}
}
],
"filters": [],
"groups": null
},
"brands": null,
"subBrands": null,
"categories": null,
"subCategories": null,
"images": [
{
"name": "",
"tag": null,
"image": "midbanner/download1.jfif",
"imageTypes": 5,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/midbanner/download1.jfif",
"mobileUrl": "",
"alt": "",
"link": "",
"description": "",
"subTitle": null,
"linkType": "1",
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": true,
"cssClass": null,
"title": "",
"displayOrder": 0,
"imageTags": []
}
],
"blogs": null,
"metaTitle": "betterstore",
"metaDescription": "betterstore",
"metaKeywords": "betterstore",
"canonicalTags": "",
"allowFacets": false,
"filters": [],
"filterCriteria": [
{
"attributeType": 2,
"operand": "=",
"groupId": 0,
"operator": "And",
"attributeValue": "982FA32A-DC58-4758-B066-19110FEEA393",
"attributeText": "JACKETS",
"fieldCode": "mappedCategories.categoryName",
"fieldName": "Category"
}
],
"pageSize": 50,
"sortBy": "0",
"link": null,
"groupSeparator": "",
"groupCode": "",
"displayTitle": false,
"groups": null,
"customInfo1": "This is my product collection descriptino",
"customInfo2": "This collection contains coats & jackers - custom info 2",
"customInfo3": "This is custom info 3",
"customFieldValue": "",
"customFieldDisplayOrder": "",
"description": "",
"mainImage": "",
"image1": "",
"image2": "",
"image3": "",
"image4": "",
"imageAnnotationsJson": "",
"imageAnnotationsJson1": "",
"imageAnnotationsJson2": "",
"imageAnnotationsJson3": "",
"imageAnnotationsJson4": "",
"displayGroupName": "",
"imageBy": 1,
"createdBy": "sandeep.singh@bettercommerce.io",
"customLinks": [],
"categoryId": 0
},
"snippets": [
{
"name": "canishub_collection",
"type": "Javascript",
"placement": "Head",
"content": "<script defer>\nwindow.addEventListener('load', function() {\n\n var prodData = JSON.parse(dataLayer[0].entity);\n\tch_pub_sub_events.publish('collection_page_view_before', {'item_id':prodData.name});\n}\n)\n</script>",
"excludedUrl": null,
"microsites": [
"9413609e-635f-44ac-b697-ad5e00cd21dc",
]
}
],
"slugType": 7
}
Get Collection details with minimal product object in response
This endpoint retrieves a collection based on the minimal product object in response.
Developers - API Operations:
Operation | Endpoint | Response |
---|---|---|
All product collection by product object in response | /api/v2/catalog/collection/slug-minimal?slug={{variable_slug}} | Get all the collection by slug. |
Required attributes
- Name
slug
- Type
- string
- Description
Unique slug for each Collection.
Response Properties
- 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 Collection
- Name
name
- Type
- string
- Description
Name of the Collection
- Name
listType
- Type
- string
- Description
Type of the List
- Name
products
- Type
- array
- Description
List of the products in the collection
- Name
slug
- Type
- string
- Description
Unique slug for each Category.
- Name
pages
- Type
- number
- Description
Pages in the Collection.
- Name
currentPage
- Type
- number
- Description
Current Pages in the Response.
- Name
prevPageUrl
- Type
- number
- Description
The URL of the Previous Page.
- Name
nextPageUrl
- Type
- number
- Description
The URL of the Next Page.
- Name
sortList
- Type
- array
- Description
Array to sort in the List.
- Name
sortBy
- Type
- string
- Description
Parameter to sort-by.
- Name
images
- Type
- array
- Description
Array of Images.
- Name
image
- Type
- string
- Description
URL of the product image
- 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
title
- Type
- string
- Description
title of the image
- Name
seoName
- Type
- string
- Description
SEO Name
- Name
stockCode
- Type
- string
- Description
Unique id of the stock
- Name
productId
- Type
- string
- Description
Unique id of the Product
- Name
minPrice
- Type
- number
- Description
Minimum price of the product
- Name
maxPrice
- Type
- number
- Description
Maximum price of the product
- Name
minPriceWithoutTax
- Type
- number
- Description
Minimum price of the product without tax
- 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
currencySymbol
- Type
- string
- Description
Symbol of 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
ProductName
- Type
- string
- Description
Price of the product to be sold
- Name
itemType
- Type
- string
- Description
Type of the item
- Name
shortDescription
- Type
- string
- Description
Short description of the product
- Name
subscriptionPlanType
- Type
- string
- Description
Type of the subscription plan
- Name
brand
- Type
- string
- Description
Name of the brand
- Name
brandSlug
- Type
- string
- Description
Slug of the brand
- Name
subBrand
- Type
- string
- Description
SubBrand of parent Brand
- Name
categoryId
- Type
- string
- Description
Category Id
- Name
categoryCode
- Type
- string
- Description
Category Code
- Name
mainCategoryId
- Type
- string
- Description
Main category Id
- Name
category
- Type
- string
- Description
Category of the product
- Name
itemTypeCode
- Type
- string
- Description
Code for the itemType
- 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
productId
- Type
- string
- Description
Unique id of the Product
- Name
productName
- Type
- string
- Description
Name of the Product
- Name
variantAttributes
- Type
- array
- Description
Array containing information about the variant attributes for the product
- Name
fieldCode
- Type
- string
- Description
Unique Code corresponding to the field
- Name
inputType
- Type
- string
- Description
Defines the Input type of the attribute
- Name
variantProductsAttributeMinimal
- Type
- array
- Description
Minimal variant products attribute array
- Name
fieldName
- Type
- string
- Description
Name of the field
- 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
- Name
filters
- Type
- array
- Description
Filters to be applied
- Name
groups
- Type
- array
- Description
Groups where the product belongs
- Name
subBrands
- Type
- array
- Description
Contains the subBrands of each Brands
- Name
categories
- Type
- array
- Description
Contains the categories
- Name
subcategories
- Type
- array
- Description
Contains the subcategories of each category
- Name
blogs
- Type
- array
- Description
Contains the blogs of each category
- Name
metaTitle
- Type
- string
- Description
MetaTitle associated with the product
- Name
metaDescription
- Type
- string
- Description
MetaDescription associated with the product
- Name
metaKeywords
- Type
- string
- Description
MetaKeywords associated with the product
- Name
canonicalTags
- Type
- string
- Description
Cannonical Tags associated with the product
- Name
allowFacets
- Type
- boolean
- Description
Flag to check Is allowFacets true or not
- Name
filterCriteria
- Type
- string
- Description
Criteria for filtering
- Name
attributeType
- Type
- string
- Description
Defines the type of attribute
- Name
groupId
- Type
- string
- Description
Unique Id of the group containing the product
- Name
pageSize
- Type
- string
- Description
Size of the page
- Name
displayTitle
- Type
- boolean
- Description
Flag to allow title to be displayed or not
- Name
customInfo1
- Type
- array
- Description
Array containing customInfo1 values
- Name
customInfo2
- Type
- array
- Description
Array containing customInfo2 values
- Name
customInfo3
- Type
- array
- Description
Array containing customInfo3 values
- Name
customFieldValue
- Type
- string
- Description
String containing customFieldValue
- Name
customFieldDisplayOrder
- Type
- string
- Description
String containing customFieldDisplayOrder
- Name
mainImage
- Type
- string
- Description
Main Image Url of the Product
- Name
image1
- Type
- string
- Description
Image1 Url of the Product
- Name
image2
- Type
- string
- Description
Image2 Url of the Product
- Name
image3
- Type
- string
- Description
Image3 Url of the Product
- Name
image4
- Type
- string
- Description
Image4 Url of the Product
- Name
displayGroupName
- Type
- string
- Description
Image4 Url of the Product
- Name
imageBy
- Type
- string
- Description
Image source title
- Name
createdBy
- Type
- string
- Description
Product created by
- Name
customLinks
- Type
- string
- Description
Custom links for the product
- Name
snippets
- Type
- array
- Description
Array containing additional code pieces to be added with the category
- Name
content
- Type
- string
- Description
Content of the each snippet added
- Name
placement
- Type
- string
- Description
Placement of the each snippet added
- Name
excludedUrl
- Type
- string
- Description
Excluded Url for each snippet added
- Name
microsites
- Type
- array
- Description
Array containing list of microsites
Request
curl --location --request GET 'https://api20.bettercommerce.io/api/v2/catalog/collection/slug-minimal?slug=coats-and-jackets' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'
Response
{
"statusCode": 200,
"status": "OK",
"errors": [],
"success": true,
"message": null,
"messageCode": null,
"result": {
"products": {
"total": 17,
"pages": 1,
"currentPage": 1,
"prevPageUrl": null,
"nextPageUrl": null,
"sortList": [
{
"key": "1",
"value": "Price : low to high"
}
],
"sortBy": "1",
"images": [
{
"name": "",
"tag": null,
"image": "midbanner/download1.jfif",
"imageTypes": 5,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/midbanner/download1.jfif",
"mobileUrl": "",
"id": null,
"alt": "",
"link": "",
"description": "",
"subTitle": null,
"linkType": "1",
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": true,
"cssClass": null,
"segment": "",
"title": "",
"displayOrder": 0,
"data": null,
"imageTags": null
}
],
"results": [
{
"recordId": "da9e87ee-8e1a-4abc-a83e-ad5e0048ca5b",
"name": "Tan Roll Neck Knitted Jumper With Puff Sleeve",
"slug": "products/my-brand-tan-roll-neck-knitted-jumper-with-puff-sleeve-bs21397-tan-onesize",
"stockCode": "BS21397-TAN-ONESIZE",
"listPrice": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£39.99",
"withoutTax": "£39.99",
"tax": "£29.99"
},
"raw": {
"withTax": 39.99,
"withoutTax": 39.99,
"tax": 29.99
}
},
"price": {
"minPrice": 10,
"minPriceWithoutTax": 10,
"maxPrice": 10,
"maxPriceWithoutTax": 10,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£10.00",
"withoutTax": "£10.00",
"tax": "£0.00"
},
"raw": {
"withTax": 10,
"withoutTax": 10,
"tax": 0
}
},
"images": [
{
"name": "Image1",
"tag": "Tan Roll Neck Knitted Jumper With Puff Sleeve",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex21397_camel_2717.webp?fm=webp",
"imageTypes": null,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/ex21397_camel_2717.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": []
}
],
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex21397_camel_2717.webp?fm=webp",
"itemType": 1,
"shortDescription": "",
"subscriptionPlanType": 0,
"groupName": null,
"brand": "My Brand",
"brandSlug": "my-brand-url",
"subBrand": "",
"sku": "BS21397",
"priceFrom": {
"minPrice": 0,
"minPriceWithoutTax": 0,
"maxPrice": 0,
"maxPriceWithoutTax": 0,
"currencyDecimalSeparator": ",",
"currencyDigitsAfterDecimal": 3,
"currencySymbol": "£",
"formatted": {
"withTax": "£10.00",
"withoutTax": "£10.00",
"tax": "£0.00"
},
"raw": {
"withTax": 10,
"withoutTax": 10,
"tax": 0
}
},
"classification": {
"categoryId": "964f0baf-3f63-4e57-866b-bbe0cb494694",
"categoryCode": "964f0baf-3f63-4e57-866b-bbe0cb494694",
"mainCategoryId": "6e3252f0-b8d5-473e-8b1f-60b62d82b5d5",
"mainCategoryName": "KNITWEAR",
"category": "JUMPERS",
"itemTypeCode": null,
"itemType": "1",
"attributeSet": "Default Attribute set",
"attributeSetId": "227edf33-1894-43fe-acba-13c795c5c564"
},
"currentStock": 91651,
"description": "<p>Weather's getting cold outside? No problem when you have our Tan Roll Neck Knitted Jumper With Puff Sleeve. With flattering gathered sleeves, puff shoulders and a roll neckline, you can stay warm whilst still maintaining style. Pair with leather trousers or your favourite pair of jeans and you're ready to battle the cold weather. </p>\n\n<p><em>Also available in Black</em></p>\n\n<p>One size fits UK size 8-12</p>\n\n<p><strong>DETAILS</strong></p>\n\n<ul>\n\t<li>\n\t<p>Extreme puffed sleeves </p>\n\t</li>\n\t<li>\n\t<p>Roll neck </p>\n\t</li>\n\t<li>\n\t<p>Ribbed knit material</p>\n\t</li>\n\t<li>\n\t<p>Long sleeves </p>\n\t</li>\n</ul>\n\n<p> </p>\n\n<p><strong>SIZE & FIT</strong></p>\n\n<p>Lulu wears ONESIZE (approximately UK 8-12 depending on desired fit)</p>\n\n<p>Model height 5”9</p>\n\n<p> </p>\n\n<p><strong>LOOK AFTER ME</strong></p>\n\n<p>Wash at 30 degrees</p>\n\n<p>Iron on low </p>\n\n<p>Do not tumble dry </p>\n\n<p> </p>\n\n<p><strong>MATERIAL</strong></p>\n\n<p>100% Acrylic</p>\n ",
"attributes": [
{
"key": "global.colour",
"value": "#d2b48c",
"display": "Colour"
}
],
"fulfilFromWarehouse": true,
"fulfilFromStore": false,
"fulfilFromSupplier": false,
"deliveryMessage": null,
"stockAvailabilityMessage": null,
"trending": false,
"bestSeller": false,
"onSale": false,
"newLaunch": true,
"exclusive": false,
"extendedDescription": null,
"variantProductsMinimal": [
{
"stockCode": "BS21397-TAN-SM",
"productId": "086bc1c5-d3e7-42b7-9641-ad5e0048ca5b",
"price": {
"minPrice": 10,
"minPriceWithoutTax": 10,
"maxPrice": 10,
"maxPriceWithoutTax": 10,
"currencyDecimalSeparator": null,
"currencyDigitsAfterDecimal": 0,
"currencySymbol": "£",
"formatted": {
"withTax": "£10.00",
"withoutTax": "£10.00",
"tax": "£0.00"
},
"raw": {
"withTax": 10,
"withoutTax": 10,
"tax": 0
}
},
"slug": "products/my-brand-tan-roll-neck-knitted-jumper-with-puff-sleeve-bs21397-tan-onesize",
"image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex21397_camel_2717.webp?fm=webp",
"productName": "Tan Roll Neck Knitted Jumper With Puff Sleeve",
"variantAttributes": [
{
"fieldCode": "clothing.size",
"fieldValue": "sm"
},
{
"fieldCode": "clothing.size",
"fieldValue": "sm"
},
{
"fieldCode": "global.colour",
"fieldValue": "#d2b48c"
}
]
}
],
"variantProductsAttributeMinimal": [
{
"fieldName": "Size",
"fieldCode": "clothing.size",
"fieldValues": [
{
"fieldCode": null,
"fieldValue": "sm"
}
]
}
],
"isVisible": true,
"isActive": false,
"isMasterStock": false,
"hasVariant": true,
"promotions": null,
"preOrder": {
"isEnabled": false,
"launchDateTime": "1900-01-01T00:00:00"
},
"seoName": ""
}
],
"filters": [],
"groups": null
},
"id": "07a708cf-fc1a-417c-b9a3-adbf0083d45d",
"name": "Coats and Jackets",
"listType": 1,
"brands": null,
"subBrands": null,
"categories": null,
"subCategories": null,
"images": [
{
"name": "",
"tag": null,
"image": "midbanner/download1.jfif",
"imageTypes": 5,
"url": "https://liveocxstorage.blob.core.windows.net/betterstore/midbanner/download1.jfif",
"mobileUrl": "",
"alt": "",
"link": "",
"description": "",
"subTitle": null,
"linkType": "1",
"buttonText": null,
"eventCategory": null,
"eventAction": null,
"gaValue": null,
"isActive": true,
"cssClass": null,
"title": "",
"displayOrder": 0,
"imageTags": []
}
],
"blogs": null,
"metaTitle": "betterstore",
"metaDescription": "betterstore",
"metaKeywords": "betterstore",
"canonicalTags": "",
"allowFacets": false,
"filters": [],
"filterCriteria": [
{
"attributeType": 2,
"operand": "=",
"groupId": 0,
"operator": "And",
"attributeValue": "982FA32A-DC58-4758-B066-19110FEEA393",
"attributeText": "JACKETS",
"fieldCode": "mappedCategories.categoryName",
"fieldName": "Category"
}
],
"pageSize": 50,
"sortBy": "0",
"link": null,
"groupSeparator": "",
"groupCode": "",
"displayTitle": false,
"groups": null,
"customInfo1": "This is my product collection descriptino",
"customInfo2": "This collection contains coats & jackers - custom info 2",
"customInfo3": "This is custom info 3",
"customFieldValue": "",
"customFieldDisplayOrder": "",
"description": "",
"mainImage": "",
"image1": "",
"image2": "",
"image3": "",
"image4": "",
"imageAnnotationsJson": "",
"imageAnnotationsJson1": "",
"imageAnnotationsJson2": "",
"imageAnnotationsJson3": "",
"imageAnnotationsJson4": "",
"displayGroupName": null,
"imageBy": 1,
"createdBy": "sandeep.singh@bettercommerce.io",
"customLinks": [],
"categoryId": 0
},
"snippets": [
{
"name": "canishub_collection",
"type": "Javascript",
"placement": "Head",
"content": "<script defer>\nwindow.addEventListener('load', function() {\n\n var prodData = JSON.parse(dataLayer[0].entity);\n\tch_pub_sub_events.publish('collection_page_view_before', {'item_id':prodData.name});\n}\n)\n</script>",
"excludedUrl": null,
"microsites": [
"9413609e-635f-44ac-b697-ad5e00cd21dc",
]
}
],
"slugType": 7
}