Brand

A brand is an entity to make their products identifiable among other products. On this page we will dive into the different brand endpoints such as Get all brands, Get brands by Product Id, etc.

GET/api/v2/catalog/brand/all

Get all the brands

This endpoint allows you to retrieve a paginated list of all your brand.

Developers - API Operations:

Operation	Endpoint	Response
Brands List	`/api/v2/catalog/brand/all`	Get all the brand list.

Required attributes

Name
brandIds
Type
array
Description
Unique brand Id listed with each Brand.

Optional attributes

Name
page
Type
number
Description
Defines the value of page number.
Name
sortBy
Type
string
Description
Defines how we need to sort by Category, Color, etc.
Name
sortOrder
Type
number
Description
Defines the order to sort the List

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
total
Type
number
Description
Qunatity of all the Brands.
Name
pages
Type
number
Description
Pages in the Brand.
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
results
Type
array
Description
Contains an Array of Object
Name
id
Type
string
Description
Id of the Brand.
Name
recordId
Type
string
Description
Id of the Brand Record
Name
manufacturerName
Type
string
Description
Name of the Manufacturer
Name
parentManufacturerName
Type
string
Description
Name of the Parent Manufacturer
Name
logoImageName
Type
string
Description
Name of the Logo Image
Name
logo
Type
string
Description
URL of the Logo Image
Name
excludeFromSearch
Type
string
Description
Value to be excluded from Search
Name
productImage
Type
string
Description
URL of the product image
Name
description
Type
string
Description
Description of the product
Name
link
Type
string
Description
Link of the product
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
langCulture
Type
string
Description
Language associated with the product
Name
categoryCode
Type
string
Description
Category code associated with the product's category
Name
displayOrder
Type
number
Description
Order of the display associated with the product
Name
isActive
Type
boolean
Description
Flag to check is product active
Name
isHighlighted
Type
boolean
Description
Flag to check is product highlighted
Name
widgetsConfig
Type
array
Description
The configuration of the widgets
Name
filters
Type
array
Description
List of filters to be applied to the product
Name
groups
Type
array
Description
List of Groups to which the product belongs
Name
slugType
Type
string
Description
Defines the type of slug
Name
snippets
Type
array
Description
Array containing additional code pieces to be added with the category

Request

GET

/api/v2/catalog/brand/all

curl -X GET --header 'Accept: application/json'\
'https://api20.bettercommerce.io/api/v2/catalog/brand/all'

Response

    {
        "statusCode": 200,
        "status": "OK",
        "errors": [],
        "success": true,
        "message": null,
        "messageCode": null,
        "result": {
            "total": 26,
            "pages": 1,
            "currentPage": 1,
            "prevPageUrl": null,
            "nextPageUrl": null,
            "sortList": null,
            "sortBy": null,
            "images": null,
            "results": [
                {
                    "id": "11208",
                    "recordId": "99c8a6b0-22fa-4bf6-82f2-ae42009e0396",
                    "manufacturerName": "Adidas",
                    "parentManufacturerName": null,
                    "logoImageName": "",
                    "logo": null,
                    "excludeFromSearch": false,
                    "productImage": null,
                    "description": "Adidas",
                    "link": "brands/adidas-11208",
                    "metaTitle": "",
                    "metaDescription": "",
                    "metaKeywords": null,
                    "canonicalTags": null,
                    "langCulture": null,
                    "categoryCode": null,
                    "displayOrder": 0,
                    "isActive": false,
                    "isHighlighted": false,
                    "widgetsConfig": null,
                }
            ],
            "filters": [],
            "groups": null
        },
        "snippets": [],
        "slugType": 0
    }

GET/api/v2/catalog/brand/id/:id

Get brand detail by Id

This endpoint allows you to retrieve brand detail using Id.

Developers - API Operations:

Operation	Endpoint	Response
Brands List	api/v2/catalog/brand/id/:id	Get all the brand list by id.

Required attributes

Name
id
Type
string
Description
Brand id to pass retrived detail

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
description
Type
string
Description
Description of the product
Name
link
Type
string
Description
Link of the product
Name
images
Type
array
Description
Array of Images.
Name
parentManufacturerName
Type
string
Description
Name of the Parent Manufacturer
Name
subBrands
Type
array
Description
Contains the subBrands of each Brands
Name
products
Type
array
Description
List of the products in the collection
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
isDefault
Type
boolean
Description
Flag to check is brand by default selected 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
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
displayInProductList
Type
boolean
Description
Flag to check display in product list
Name
groupDisplayOrder
Type
number
Description
Order of the group display
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
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
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
langCulture
Type
string
Description
Language associated with the product
Name
premiumBrandLogo
Type
string
Description
Url of the Logo
Name
manufacturerSettings
Type
array
Description
Array defining the manufacturer setting attributes
Name
excludeFromSearch
Type
boolean
Description
Flag to check is brand excluded from search or not
Name
showSiteStrip
Type
boolean
Description
Flag to check is show Site trip true or false
Name
fulfillFromStore
Type
boolean
Description
Flag to check is fulfilFromStore or not
Name
enableMoreAbout
Type
boolean
Description
Flag to check is More about enabled or not
Name
hideBrandVisibility
Type
boolean
Description
Flag to check is brand visibility hidden or not
Name
privateBrandImage
Type
string
Description
Private image Url for the brand
Name
parentManufSlug
Type
string
Description
Slug of the Parent manufacturer of the brand
Name
parentLogoImageName
Type
string
Description
Parent's logo image name
Name
isHighlighted
Type
boolean
Description
Flag to check is product highlighted
Name
widgetsConfig
Type
array
Description
Array containing configuration of the widgets

Request

GET

/api/v2/catalog/brand/id/:id

curl --location --request GET 'https://api20.bettercommerce.io/api/v2/catalog/brand/id/99c8a6b0-22fa-4bf6-82f2-ae42009e0396' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
    "statusCode": 200,
    "status": "OK",
    "errors": [],
    "success": true,
    "message": null,
    "messageCode": null,
    "result": {
        "id": "9693",
        "recordId": "9a6403f1-a5ab-45eb-8fa2-ae0400d4bc90",
        "name": "KÄLLEMO",
        "link": "brands/kallemo-9693",
        "logoImageName": "",
        "productImage": "",
        "description": "<html>\n<head>\n\t<title></title>\n</head>\n<body>\n<p>K&Auml;LLEMO</p>\n</body>\n</html>\n",
        "images": [],
        "parentManufacturerName": null,
        "subBrands": [
            {
                "id": "0",
                "name": "",
                "link": null,
                "products": [
                    {
                        "id": "5642879171",
                        "seoName": "",
                        "barcode": null,
                        "isFeatured": false,
                        "uom": "BAG",
                        "uomValue": 0,
                        "variant": {
                            "variantInputType": 1,
                            "listType": 1,
                            "independentProductUrl": false,
                            "displayInProductWidget": true,
                            "displayInProductDetail": true,
                            "attributes": [
                                {
                                    "fieldName": "Upholstery",
                                    "fieldCode": "furniture.upholstery",
                                    "inputType": "Dropdown",
                                    "products": [
                                        {
                                            "stockCode": "139D",
                                            "barCode": "139d",
                                            "productId": "e8bd3f36-bf63-4507-b67c-5d322eea8a5e",
                                            "isDefault": false,
                                            "fieldValue": "tärnsjöläder-8175",
                                            "image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/139d.jpg?fm=webp",
                                            "fieldLabel": "",
                                            "listPrice": {
                                                "minPrice": 0,
                                                "minPriceWithoutTax": 0,
                                                "maxPrice": 0,
                                                "maxPriceWithoutTax": 0,
                                                "currencyDecimalSeparator": null,
                                                "currencyDigitsAfterDecimal": 0,
                                                "currencySymbol": "£",
                                                "formatted": {
                                                    "withTax": "£0.00",
                                                    "withoutTax": "£0.00",
                                                    "tax": "£-11.00"
                                                },
                                                "raw": {
                                                    "withTax": 0,
                                                    "withoutTax": 0,
                                                    "tax": -11
                                                }
                                            },
                                            "sellPrice": {
                                                "minPrice": 11,
                                                "minPriceWithoutTax": 11,
                                                "maxPrice": 11,
                                                "maxPriceWithoutTax": 11,
                                                "currencyDecimalSeparator": null,
                                                "currencyDigitsAfterDecimal": 0,
                                                "currencySymbol": "£",
                                                "formatted": {
                                                    "withTax": "£11.00",
                                                    "withoutTax": "£11.00",
                                                    "tax": "£0.00"
                                                },
                                                "raw": {
                                                    "withTax": 11,
                                                    "withoutTax": 11,
                                                    "tax": 0
                                                }
                                            },
                                            "productName": "alumni",
                                            "slug": "products/kallemo-alumni-139d",
                                            "defaultForFrontend": true,
                                            "sellWithoutInventory": false,
                                            "currentStock": 11,
                                            "isPreOrderEnabled": false,
                                            "enableNotifyMe": false,
                                            "isActive": true,
                                            "isVisible": true,
                                            "description": null
                                        }
                                    ]
                                }
                            ],
                            "variantInputTypes": "Dropdown:furniture.finish,Dropdown:furniture.legs,Dropdown:furniture.upholstery"
                        },
                        "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": "139D",
                                "productId": "e8bd3f36-bf63-4507-b67c-5d322eea8a5e",
                                "slug": "products/kallemo-alumni-139d",
                                "image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/139d.jpg?fm=webp",
                                "productName": "alumni",
                                "listPrice": {
                                    "minPrice": 0,
                                    "minPriceWithoutTax": 0,
                                    "maxPrice": 0,
                                    "maxPriceWithoutTax": 0,
                                    "currencyDecimalSeparator": null,
                                    "currencyDigitsAfterDecimal": 0,
                                    "currencySymbol": "£",
                                    "formatted": {
                                        "withTax": "£0.00",
                                        "withoutTax": "£0.00",
                                        "tax": "£-11.00"
                                    },
                                    "raw": {
                                        "withTax": 0,
                                        "withoutTax": 0,
                                        "tax": -11
                                    }
                                },
                                "price": {
                                    "minPrice": 11,
                                    "minPriceWithoutTax": 11,
                                    "maxPrice": 11,
                                    "maxPriceWithoutTax": 11,
                                    "currencyDecimalSeparator": null,
                                    "currencyDigitsAfterDecimal": 0,
                                    "currencySymbol": "£",
                                    "formatted": {
                                        "withTax": "£11.00",
                                        "withoutTax": "£11.00",
                                        "tax": "£0.00"
                                    },
                                    "raw": {
                                        "withTax": 11,
                                        "withoutTax": 11,
                                        "tax": 0
                                    }
                                },
                                "isDefault": false,
                                "isPreOrderEnabled": false,
                                "sellWithoutInventory": false,
                                "currentStock": 0,
                                "description": null,
                                "attributes": [
                                    {
                                        "fieldCode": "furniture.upholstery",
                                        "fieldName": "Upholstery",
                                        "fieldValue": "tärnsjöläder-8175",
                                        "fieldLabel": ""
                                    }
                                ]
                            }
                        ],
                        "variantProductsAttribute": [
                            {
                                "fieldName": "Upholstery",
                                "fieldCode": "furniture.upholstery",
                                "fieldLabel": null,
                                "inputType": "Dropdown",
                                "fieldValues": [
                                    {
                                        "fieldValue": "tärnsjöläder-8175",
                                        "fieldLabel": null
                                    }
                                ],
                                "independentProductUrl": false,
                                "displayInProductDetail": true,
                                "displayInProductWidget": true
                            }
                        ],
                        "subscriptionEnabled": false,
                        "minPrice": null,
                        "maxPrice": null,
                        "displayTemplate": "",
                        "brandLogo": null,
                        "attributes": [
                            {
                                "key": "furniture.finish",
                                "customkey": "furniture.finish~Karm i naturlig bok~Finish",
                                "display": "Finish",
                                "value": "Karm i naturlig bok",
                                "originalValue": null,
                                "isVariantAttribute": false,
                                "displayInProductDetail": false,
                                "displayInProductList": true,
                                "groupDisplayOrder": 0
                            }
                        ],
                        "recordId": "2223fcd7-2b90-4f19-b8d3-7791c1b36039",
                        "name": "alumni",
                        "slug": "products/kallemo-alumni-139a",
                        "stockCode": "139A",
                        "listPrice": {
                            "minPrice": 0,
                            "minPriceWithoutTax": 0,
                            "maxPrice": 0,
                            "maxPriceWithoutTax": 0,
                            "currencyDecimalSeparator": null,
                            "currencyDigitsAfterDecimal": 0,
                            "currencySymbol": "£",
                            "formatted": {
                                "withTax": "£0.00",
                                "withoutTax": "£0.00",
                                "tax": "£-11.00"
                            },
                            "raw": {
                                "withTax": 0,
                                "withoutTax": 0,
                                "tax": -11
                            }
                        },
                        "price": {
                            "minPrice": 11,
                            "minPriceWithoutTax": 11,
                            "maxPrice": 11,
                            "maxPriceWithoutTax": 11,
                            "currencyDecimalSeparator": null,
                            "currencyDigitsAfterDecimal": 0,
                            "currencySymbol": "£",
                            "formatted": {
                                "withTax": "£11.00",
                                "withoutTax": "£11.00",
                                "tax": "£0.00"
                            },
                            "raw": {
                                "withTax": 11,
                                "withoutTax": 11,
                                "tax": 0
                            }
                        },
                        "images": [
                            {
                                "name": "Image1",
                                "tag": "139A",
                                "image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/139a.jpg?fm=webp",
                                "imageTypes": null,
                                "url": "https://liveocxstorage.blob.core.windows.net/betterstore/products/139a.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": "https://liveocxstorage.blob.core.windows.net/betterstore/products/139a.jpg?fm=webp",
                        "itemType": 1,
                        "shortDescription": "",
                        "subscriptionPlanType": 0,
                        "groupName": null,
                        "brand": "KÄLLEMO",
                        "brandSlug": null,
                        "subBrand": "",
                        "sku": "1399",
                        "priceFrom": {
                            "minPrice": 0,
                            "minPriceWithoutTax": 0,
                            "maxPrice": 0,
                            "maxPriceWithoutTax": 0,
                            "currencyDecimalSeparator": ",",
                            "currencyDigitsAfterDecimal": 3,
                            "currencySymbol": "£",
                            "formatted": {
                                "withTax": "£11.00",
                                "withoutTax": "£11.00",
                                "tax": "£0.00"
                            },
                            "raw": {
                                "withTax": 11,
                                "withoutTax": 11,
                                "tax": 0
                            }
                        },
                        "classification": {
                            "categoryId": "ee514ac0-3e4c-4fc2-8cb2-626364ef5037",
                            "categoryCode": "ee514ac0-3e4c-4fc2-8cb2-626364ef5037",
                            "mainCategoryId": "8e96d7ab-9695-4db3-add6-65ec8f7a3259",
                            "mainCategoryName": "DRESSES",
                            "category": "MAXI",
                            "itemTypeCode": null,
                            "itemType": "1",
                            "attributeSet": "Furniture",
                            "attributeSetId": "c084a603-6399-4ca0-a681-f8a5f1072ffc"
                        },
                        "currentStock": 11,
                        "description": "",
                        "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"
                        }
                    }
                ],
                "categoryCode": null,
                "displayOrder": 0,
                "isActive": false
            }
        ],
        "showLandingPage": false,
        "metaTitle": "",
        "metaDescription": "",
        "metaKeywords": "",
        "canonicalTags": "",
        "productList": null,
        "displayTemplate": "BrandLanding.cshtml",
        "parentId": "00000000-0000-0000-0000-000000000000",
        "parentIid": 0,
        "categoryCode": null,
        "isCustomUrl": false,
        "customURL": null,
        "langCulture": null,
        "shortDescription": "<html>\n<head>\n\t<title></title>\n</head>\n<body></body>\n</html>\n",
        "premiumBrandLogo": "",
        "manufacturerSettings": null,
        "excludeFromSearch": false,
        "showSiteStrip": false,
        "enableMoreAbout": false,
        "hideBrandVisibility": false,
        "hideSubbrandVisibility": false,
        "privateBrandImage": null,
        "parentManufSlug": "",
        "parentLogoImageName": "",
        "isActive": true,
        "isHighlighted": false,
        "widgetsConfig": "[\r\n  {\r\n    \"recordId\": \"a67b7331-b4c4-46b8-b7e1-ad710095f98e\",\r\n    \"name\": \"New Collection Test\",\r\n    \"manufacturerSettingType\": \"ProductCollection\",\r\n    \"heading\": \"Product Collection\",\r\n    \"code\": \"PC\",\r\n    \"displayOrder\": 1,\r\n    \"buttonLink\": null\r\n  },\r\n  {\r\n    \"recordId\": null,\r\n    \"name\": \"https://liveocxstorage.blob.core.windows.net/betterstore/banner/banner1.jpg\",\r\n    \"manufacturerSettingType\": \"ImageBanner\",\r\n    \"heading\": \"Images\",\r\n    \"code\": \"IB\",\r\n    \"displayOrder\": 2,\r\n    \"buttonLink\": null\r\n  }\r\n]"
    }
}

POST/api/v2/catalog/brand/slug?slug={{variable_slug}}

Get brand by slug

This endpoint allows you to retrieve brand detail using slug.

Developers - API Operations:

Operation	Endpoint	Response
Brand Details	`/api/v2/catalog/brand/slug?slug={{variable_slug}}`	Get brand deail by slug.

Required attributes

Name
slug
Type
string
Description
Brand slug to pass retrive details

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
description
Type
string
Description
Description of the product
Name
link
Type
string
Description
Link of the product
Name
images
Type
array
Description
Array of Images.
Name
parentManufacturerName
Type
string
Description
Name of the Parent Manufacturer
Name
subBrands
Type
array
Description
Contains the subBrands of each Brands
Name
products
Type
array
Description
List of the products in the collection
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
isDefault
Type
boolean
Description
Flag to check is brand by default selected 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
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
displayInProductList
Type
boolean
Description
Flag to check display in product list
Name
groupDisplayOrder
Type
number
Description
Order of the group display
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
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
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
langCulture
Type
string
Description
Language associated with the product
Name
premiumBrandLogo
Type
string
Description
Url of the Logo
Name
manufacturerSettings
Type
array
Description
Array defining the manufacturer setting attributes
Name
excludeFromSearch
Type
boolean
Description
Flag to check is brand excluded from search or not
Name
showSiteStrip
Type
boolean
Description
Flag to check is show Site trip true or false
Name
fulfillFromStore
Type
boolean
Description
Flag to check is fulfilFromStore or not
Name
enableMoreAbout
Type
boolean
Description
Flag to check is More about enabled or not
Name
hideBrandVisibility
Type
boolean
Description
Flag to check is brand visibility hidden or not
Name
privateBrandImage
Type
string
Description
Private image Url for the brand
Name
parentManufSlug
Type
string
Description
Slug of the Parent manufacturer of the brand
Name
parentLogoImageName
Type
string
Description
Parent's logo image name
Name
isHighlighted
Type
boolean
Description
Flag to check is product highlighted
Name
widgetsConfig
Type
array
Description
Array containing configuration of the widgets

Request

POST

/api/v2/catalog/brand/slug?slug=adidas

curl --location --request POST 'https://api20.bettercommerce.io/api/v2/catalog/brand/slug?slug=brands/adidas-11208' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
    "statusCode": 200,
    "status": "OK",
    "errors": [],
    "success": true,
    "message": null,
    "messageCode": null,
    "result": {
        "id": "9693",
        "recordId": "9a6403f1-a5ab-45eb-8fa2-ae0400d4bc90",
        "name": "KÄLLEMO",
        "link": "brands/kallemo-9693",
        "logoImageName": "",
        "productImage": "",
        "description": "<html>\n<head>\n\t<title></title>\n</head>\n<body>\n<p>K&Auml;LLEMO</p>\n</body>\n</html>\n",
        "images": [],
        "parentManufacturerName": null,
        "subBrands": [],
        "showLandingPage": false,
        "metaTitle": " | Betterstore",
        "metaDescription": " | Betterstore",
        "metaKeywords": " | Betterstore",
        "canonicalTags": "",
        "productList": {
            "total": 29,
            "pages": 1,
            "currentPage": 1,
            "prevPageUrl": null,
            "nextPageUrl": null,
            "sortList": [
                {
                    "key": "1",
                    "value": "Price : low to high"
                }
            ],
            "sortBy": "1",
            "images": null,
            "results": [
                {
                    "id": "5642879171",
                    "seoName": "",
                    "barcode": null,
                    "isFeatured": false,
                    "uom": "BAG",
                    "uomValue": 0,
                    "variant": {
                        "variantInputType": 1,
                        "listType": 1,
                        "independentProductUrl": false,
                        "displayInProductWidget": true,
                        "displayInProductDetail": true,
                        "attributes": [
                            {
                                "fieldName": "Upholstery",
                                "fieldCode": "furniture.upholstery",
                                "inputType": "Dropdown",
                                "products": [
                                    {
                                        "stockCode": "139D",
                                        "barCode": "139d",
                                        "productId": "e8bd3f36-bf63-4507-b67c-5d322eea8a5e",
                                        "isDefault": false,
                                        "fieldValue": "tärnsjöläder-8175",
                                        "image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/139d.jpg?fm=webp",
                                        "fieldLabel": "",
                                        "listPrice": {
                                            "minPrice": 0,
                                            "minPriceWithoutTax": 0,
                                            "maxPrice": 0,
                                            "maxPriceWithoutTax": 0,
                                            "currencyDecimalSeparator": null,
                                            "currencyDigitsAfterDecimal": 0,
                                            "currencySymbol": "£",
                                            "formatted": {
                                                "withTax": "£0.00",
                                                "withoutTax": "£0.00",
                                                "tax": "£-11.00"
                                            },
                                            "raw": {
                                                "withTax": 0,
                                                "withoutTax": 0,
                                                "tax": -11
                                            }
                                        },
                                        "sellPrice": {
                                            "minPrice": 11,
                                            "minPriceWithoutTax": 11,
                                            "maxPrice": 11,
                                            "maxPriceWithoutTax": 11,
                                            "currencyDecimalSeparator": null,
                                            "currencyDigitsAfterDecimal": 0,
                                            "currencySymbol": "£",
                                            "formatted": {
                                                "withTax": "£11.00",
                                                "withoutTax": "£11.00",
                                                "tax": "£0.00"
                                            },
                                            "raw": {
                                                "withTax": 11,
                                                "withoutTax": 11,
                                                "tax": 0
                                            }
                                        },
                                        "productName": "alumni",
                                        "slug": "products/kallemo-alumni-139d",
                                        "defaultForFrontend": true,
                                        "sellWithoutInventory": false,
                                        "currentStock": 11,
                                        "isPreOrderEnabled": false,
                                        "enableNotifyMe": false,
                                        "isActive": true,
                                        "isVisible": true,
                                        "description": null
                                    }
                                ]
                            }
                        ],
                        "variantInputTypes": "Dropdown:furniture.finish,Dropdown:furniture.legs,Dropdown:furniture.upholstery"
                    },
                    "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": "139D",
                            "productId": "e8bd3f36-bf63-4507-b67c-5d322eea8a5e",
                            "slug": "products/kallemo-alumni-139d",
                            "image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/139d.jpg?fm=webp",
                            "productName": "alumni",
                            "listPrice": {
                                "minPrice": 0,
                                "minPriceWithoutTax": 0,
                                "maxPrice": 0,
                                "maxPriceWithoutTax": 0,
                                "currencyDecimalSeparator": null,
                                "currencyDigitsAfterDecimal": 0,
                                "currencySymbol": "£",
                                "formatted": {
                                    "withTax": "£0.00",
                                    "withoutTax": "£0.00",
                                    "tax": "£-11.00"
                                },
                                "raw": {
                                    "withTax": 0,
                                    "withoutTax": 0,
                                    "tax": -11
                                }
                            },
                            "price": {
                                "minPrice": 11,
                                "minPriceWithoutTax": 11,
                                "maxPrice": 11,
                                "maxPriceWithoutTax": 11,
                                "currencyDecimalSeparator": null,
                                "currencyDigitsAfterDecimal": 0,
                                "currencySymbol": "£",
                                "formatted": {
                                    "withTax": "£11.00",
                                    "withoutTax": "£11.00",
                                    "tax": "£0.00"
                                },
                                "raw": {
                                    "withTax": 11,
                                    "withoutTax": 11,
                                    "tax": 0
                                }
                            },
                            "isDefault": false,
                            "isPreOrderEnabled": false,
                            "sellWithoutInventory": false,
                            "currentStock": 0,
                            "description": null,
                            "attributes": [
                                {
                                    "fieldCode": "furniture.upholstery",
                                    "fieldName": "Upholstery",
                                    "fieldValue": "tärnsjöläder-8175",
                                    "fieldLabel": ""
                                }
                            ]
                        }
                    ],
                    "variantProductsAttribute": [
                        {
                            "fieldName": "Upholstery",
                            "fieldCode": "furniture.upholstery",
                            "fieldLabel": null,
                            "inputType": "Dropdown",
                            "fieldValues": [
                                {
                                    "fieldValue": "tärnsjöläder-8175",
                                    "fieldLabel": null
                                }
                            ],
                            "independentProductUrl": false,
                            "displayInProductDetail": true,
                            "displayInProductWidget": true
                        }
                    ],
                    "subscriptionEnabled": false,
                    "minPrice": null,
                    "maxPrice": null,
                    "displayTemplate": "",
                    "brandLogo": null,
                    "attributes": [
                        {
                            "key": "furniture.finish",
                            "customkey": "furniture.finish~Karm i naturlig bok~Finish",
                            "display": "Finish",
                            "value": "Karm i naturlig bok",
                            "originalValue": null,
                            "isVariantAttribute": false,
                            "displayInProductDetail": false,
                            "displayInProductList": true,
                            "groupDisplayOrder": 0
                        }
                    ],
                    "recordId": "2223fcd7-2b90-4f19-b8d3-7791c1b36039",
                    "name": "alumni",
                    "slug": "products/kallemo-alumni-139a",
                    "stockCode": "139A",
                    "listPrice": {
                        "minPrice": 0,
                        "minPriceWithoutTax": 0,
                        "maxPrice": 0,
                        "maxPriceWithoutTax": 0,
                        "currencyDecimalSeparator": null,
                        "currencyDigitsAfterDecimal": 0,
                        "currencySymbol": "£",
                        "formatted": {
                            "withTax": "£0.00",
                            "withoutTax": "£0.00",
                            "tax": "£-11.00"
                        },
                        "raw": {
                            "withTax": 0,
                            "withoutTax": 0,
                            "tax": -11
                        }
                    },
                    "price": {
                        "minPrice": 11,
                        "minPriceWithoutTax": 11,
                        "maxPrice": 11,
                        "maxPriceWithoutTax": 11,
                        "currencyDecimalSeparator": null,
                        "currencyDigitsAfterDecimal": 0,
                        "currencySymbol": "£",
                        "formatted": {
                            "withTax": "£11.00",
                            "withoutTax": "£11.00",
                            "tax": "£0.00"
                        },
                        "raw": {
                            "withTax": 11,
                            "withoutTax": 11,
                            "tax": 0
                        }
                    },
                    "images": [
                        {
                            "name": "Image1",
                            "tag": "139A",
                            "image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/139a.jpg?fm=webp",
                            "imageTypes": null,
                            "url": "https://liveocxstorage.blob.core.windows.net/betterstore/products/139a.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": "https://liveocxstorage.blob.core.windows.net/betterstore/products/139a.jpg?fm=webp",
                    "itemType": 1,
                    "shortDescription": "",
                    "subscriptionPlanType": 0,
                    "groupName": null,
                    "brand": "KÄLLEMO",
                    "brandSlug": null,
                    "subBrand": "",
                    "sku": "1399",
                    "priceFrom": {
                        "minPrice": 0,
                        "minPriceWithoutTax": 0,
                        "maxPrice": 0,
                        "maxPriceWithoutTax": 0,
                        "currencyDecimalSeparator": ",",
                        "currencyDigitsAfterDecimal": 3,
                        "currencySymbol": "£",
                        "formatted": {
                            "withTax": "£11.00",
                            "withoutTax": "£11.00",
                            "tax": "£0.00"
                        },
                        "raw": {
                            "withTax": 11,
                            "withoutTax": 11,
                            "tax": 0
                        }
                    },
                    "classification": {
                        "categoryId": "ee514ac0-3e4c-4fc2-8cb2-626364ef5037",
                        "categoryCode": "ee514ac0-3e4c-4fc2-8cb2-626364ef5037",
                        "mainCategoryId": "8e96d7ab-9695-4db3-add6-65ec8f7a3259",
                        "mainCategoryName": "DRESSES",
                        "category": "MAXI",
                        "itemTypeCode": null,
                        "itemType": "1",
                        "attributeSet": "Furniture",
                        "attributeSetId": "c084a603-6399-4ca0-a681-f8a5f1072ffc"
                    },
                    "currentStock": 11,
                    "description": "",
                    "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
        },
        "displayTemplate": "BrandLanding.cshtml",
        "parentId": "00000000-0000-0000-0000-000000000000",
        "parentIid": 0,
        "categoryCode": null,
        "isCustomUrl": false,
        "customURL": null,
        "langCulture": null,
        "shortDescription": "<html>\n<head>\n\t<title></title>\n</head>\n<body></body>\n</html>\n",
        "premiumBrandLogo": "",
        "manufacturerSettings": null,
        "excludeFromSearch": false,
        "showSiteStrip": false,
        "enableMoreAbout": false,
        "hideBrandVisibility": false,
        "hideSubbrandVisibility": false,
        "privateBrandImage": null,
        "parentManufSlug": "",
        "parentLogoImageName": "",
        "isActive": true,
        "isHighlighted": false,
        "widgetsConfig": "[\r\n  {\r\n    \"recordId\": \"a67b7331-b4c4-46b8-b7e1-ad710095f98e\",\r\n    \"name\": \"New Collection Test\",\r\n    \"manufacturerSettingType\": \"ProductCollection\",\r\n    \"heading\": \"Product Collection\",\r\n    \"code\": \"PC\",\r\n    \"displayOrder\": 1,\r\n    \"buttonLink\": null\r\n  },\r\n  {\r\n    \"recordId\": null,\r\n    \"name\": \"https://liveocxstorage.blob.core.windows.net/betterstore/banner/banner1.jpg\",\r\n    \"manufacturerSettingType\": \"ImageBanner\",\r\n    \"heading\": \"Images\",\r\n    \"code\": \"IB\",\r\n    \"displayOrder\": 2,\r\n    \"buttonLink\": null\r\n  }\r\n]"
    },
    "snippets": [],
    "slugType": 3
}