Search

Search is a functionality which seamlessly allows you to do search operations in our website. On this page, we’ll dive into the different search endpoints.

POST/api/v2/catalog/search/advanced

Advanced faceted search

This endpoint introduces advanced facated search capabilities.

Developers - API Operations:

Operation	Endpoint	Response
Advanced faceted search	`/api/v2/catalog/search/advanced`	Post advanced faceted search

Model attributes

Name
freeText
Type
string
Description
Text value input by the customer
Name
collectionId
Type
string
Description
Unique id of the collection
Name
brandId
Type
string
Description
Unique brand Id of the Brand.
Name
brand
Type
string
Description
Name of the brand
Name
brandIds
Type
array
Description
Unique brand Id listed with each Brand.
Name
excludedBrandIds
Type
array
Description
Excluded brandIds for each attribute
Name
facet
Type
string
Description
Keyword in the input for better search results
Name
categoryId
Type
string
Description
Category Id
Name
category
Type
string
Description
Category of the product
Name
barcode
Type
string
Description
Unique value for each product
Name
categoryIds
Type
array
Description
List of Category Ids
Name
ExcludedcategoryIds
Type
array
Description
List of excluded category Ids
Name
gender
Type
string
Description
Contains the gender of the customer
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
Name
currentPage
Type
number
Description
Current Pages in the Response.
Name
pageSize
Type
string
Description
Size of the page
Name
filters
Type
array
Description
List of filters to be applied to the product
Name
allowFacets
Type
boolean
Description
Flag to check Is allowFacets true or not
Name
facetOnly
Type
boolean
Description
Flag to check Is facetOnly true or not
Name
includeFreeProduct
Type
boolean
Description
Flag to check is it includes free product or not
Name
includeExcludedBrand
Type
boolean
Description
Flag to check the inclusion of the excluded brand
Name
ignoreDisplayInSerach
Type
boolean
Description
Flag to check is ignoreDisplayInSerach true or not
Name
ignoreRollup
Type
boolean
Description
Flag to check Is ignoreRollup true or not
Name
promoCode
Type
string
Description
Promo code applied by the customer

Response attributes

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
booleanean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
object
Description
Result of the response
Name
recordId
Type
string
Description
Unique Id of the Product in Brand Record
Name
id
Type
string
Description
Product GUID identifier
Name
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
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
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
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
image
Type
string
Description
URL of the Image of the product
Name
images
Type
array
Description
Array containing the list of Images
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
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
imageTags
Type
array
Description
Tags associated with each Image
Name
name
Type
string
Description
Name of the attribute
Name
displayOrder
Type
number
Description
Order of the display associated with the product
Name
count
Type
number
Description
Count of the Item
Name
groups
Type
object
Description
Groups associated with the Item
Name
snippets
Type
array
Description
Additional code pieces to be added with the search
Name
slugType
Type
string
Description
Defines the type of slug

Request

POST

/api/v2/catalog/search/advanced

curl --location --request POST 'https://api20.bettercommerce.io/api/v2/catalog/search/advanced' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597' \
--data-urlencode 'freeText=red' \
--data-urlencode 'currentPage=1' \
--data-urlencode 'pageSize=20' \
--data-urlencode 'allowFacet=true'

Response

{
    "statusCode": 200,
    "status": "OK",
    "errors": [],
    "success": true,
    "message": null,
    "messageCode": null,
    "result": {
        "total": 103,
        "pages": 6,
        "currentPage": 1,
        "prevPageUrl": null,
        "nextPageUrl": null,
        "sortList": [
            {
                "key": "1",
                "value": "Price : low to high"
            }
        ],
        "sortBy": "1",
        "images": null,
        "results": [
            {
                "id": "5642879913",
                "seoName": "OUTBOUND 1st SIMPLE PRODUCT English",
                "barcode": null,
                "isFeatured": false,
                "uom": null,
                "uomValue": 0,
                "variant": {
                    "variantInputType": 0,
                    "listType": 0,
                    "independentProductUrl": false,
                    "displayInProductWidget": false,
                    "displayInProductDetail": false,
                    "attributes": null,
                    "variantInputTypes": null
                },
                "attributeSet": null,
                "relatedProducts": [],
                "displayOrder": 0,
                "metaTitle": "OUTBOUND 1st SIMPLE PRODUCT",
                "metaDescription": "",
                "metaKeywords": null,
                "canonicalTags": null,
                "flags": {
                    "isFreeDelivery": false,
                    "sellWithoutInventory": false
                },
                "isDiscontinued": false,
                "freeProducts": [],
                "link": null,
                "componentProducts": null,
                "componentsInStock": false,
                "variantProducts": null,
                "variantProductsAttribute": null,
                "subscriptionEnabled": false,
                "minPrice": null,
                "maxPrice": null,
                "displayTemplate": "",
                "brandLogo": null,
                "attributes": [
                    {
                        "key": "dress.style",
                        "customkey": "dress.style~aysymetric~dress style",
                        "display": "dress style",
                        "value": "aysymetric",
                        "originalValue": null,
                        "isVariantAttribute": false,
                        "displayInProductDetail": false,
                        "displayInProductList": false,
                        "groupDisplayOrder": 0
                    }
                ],
                "recordId": "cfae6217-bc8b-4385-a561-b515a7cb283f",
                "name": "OUTBOUND 1st SIMPLE PRODUCT-English",
                "slug": "products/carl-hansen-outbound-1st-simple-product-ofsp001",
                "stockCode": "OFSP001",
                "listPrice": {
                    "minPrice": 0,
                    "minPriceWithoutTax": 0,
                    "maxPrice": 0,
                    "maxPriceWithoutTax": 0,
                    "currencyDecimalSeparator": null,
                    "currencyDigitsAfterDecimal": 0,
                    "currencySymbol": "£",
                    "formatted": {
                        "withTax": "£4.00",
                        "withoutTax": "£4.00",
                        "tax": "£1.00"
                    },
                    "raw": {
                        "withTax": 4,
                        "withoutTax": 4,
                        "tax": 1
                    }
                },
                "price": {
                    "minPrice": 3,
                    "minPriceWithoutTax": 3,
                    "maxPrice": 3,
                    "maxPriceWithoutTax": 3,
                    "currencyDecimalSeparator": null,
                    "currencyDigitsAfterDecimal": 0,
                    "currencySymbol": "£",
                    "formatted": {
                        "withTax": "£3.00",
                        "withoutTax": "£3.00",
                        "tax": "£0.00"
                    },
                    "raw": {
                        "withTax": 3,
                        "withoutTax": 3,
                        "tax": 0
                    }
                },
                "images": [
                    {
                        "name": "Image1",
                        "tag": null,
                        "image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/ob0.jpg?fm=webp",
                        "imageTypes": null,
                        "url": "https://liveocxstorage.blob.core.windows.net/betterstore/products/ob0.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/ob0.jpg?fm=webp",
                "itemType": 1,
                "shortDescription": "<p>OUTBOUND 1st SIMPLE PRODUCT description</p>\n",
                "subscriptionPlanType": 0,
                "groupName": null,
                "brand": "CARL HANSEN",
                "brandSlug": null,
                "subBrand": "",
                "sku": "OFSP001",
                "priceFrom": {
                    "minPrice": 3,
                    "minPriceWithoutTax": 3,
                    "maxPrice": 3,
                    "maxPriceWithoutTax": 3,
                    "currencyDecimalSeparator": null,
                    "currencyDigitsAfterDecimal": 0,
                    "currencySymbol": "£",
                    "formatted": {
                        "withTax": "£3.00",
                        "withoutTax": "£3.00",
                        "tax": "£0.00"
                    },
                    "raw": {
                        "withTax": 3,
                        "withoutTax": 3,
                        "tax": 0
                    }
                },
                "classification": {
                    "categoryId": "e5e49358-2d37-4d04-bd98-1ba87f2d1111",
                    "categoryCode": "e5e49358-2d37-4d04-bd98-1ba87f2d1111",
                    "mainCategoryId": "685d0abf-d352-4f9a-b9ce-07eeb781c905",
                    "mainCategoryName": "Bedding",
                    "category": "Comforter",
                    "itemTypeCode": null,
                    "itemType": "1",
                    "attributeSet": "Default Attribute set",
                    "attributeSetId": "227edf33-1894-43fe-acba-13c795c5c564"
                },
                "currentStock": 33,
                "description": "<p>OUTBOUND 1st SIMPLE PRODUCT description</p>\n",
                "fulfilFromWarehouse": true,
                "fulfilFromStore": false,
                "fulfilFromSupplier": false,
                "deliveryMessage": null,
                "stockAvailabilityMessage": null,
                "trending": false,
                "bestSeller": false,
                "onSale": false,
                "newLaunch": false,
                "exclusive": false,
                "extendedDescription": null,
                "variantProductsMinimal": null,
                "variantProductsAttributeMinimal": null,
                "isVisible": true,
                "isActive": true,
                "isMasterStock": true,
                "hasVariant": false,
                "promotions": null,
                "preOrder": {
                    "isEnabled": false,
                    "launchDateTime": "1900-01-01T00:00:00"
                }
            }
        ],
        "filters": [
            {
                "name": "Brand",
                "key": "brandNoAnlz",
                "displayOrder": 0,
                "items": [
                    {
                        "name": "Aquatica",
                        "from": null,
                        "to": null,
                        "count": 5,
                        "displayOrder": 0
                    }
                ]
            }
        ],
        "groups": null
    },
    "snippets": [],
    "slugType": 0
}

POST/api/v2/catalog/search/advanced/minimal

Advanced faceted search with minimal return object

This endpoint introduces advanced facated search capabilities with minimal return object.

Developers - API Operations:

Operation	Endpoint	Response
Advanced faceted search	`/api/v2/catalog/search/advanced/minimal`	Advanced faceted search with minimal return object

Model attributes

Name
freeText
Type
string
Description
Text value input by the customer
Name
collectionId
Type
string
Description
Unique id of the collection
Name
brandId
Type
string
Description
Unique brand Id of the Brand.
Name
brand
Type
string
Description
Name of the brand
Name
brandIds
Type
array
Description
Unique brand Id listed with each Brand.
Name
excludedBrandIds
Type
array
Description
Excluded brandIds for each attribute
Name
facet
Type
string
Description
Keyword in the input for better search results
Name
categoryId
Type
string
Description
Category Id
Name
category
Type
string
Description
Category of the product
Name
barcode
Type
string
Description
Unique value for each product
Name
categoryIds
Type
array
Description
List of Category Ids
Name
ExcludedcategoryIds
Type
array
Description
List of excluded category Ids
Name
gender
Type
string
Description
Contains the gender of the customer
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
Name
currentPage
Type
number
Description
Current Pages in the Response.
Name
pageSize
Type
string
Description
Size of the page
Name
filters
Type
array
Description
List of filters to be applied to the product
Name
allowFacets
Type
boolean
Description
Flag to check Is allowFacets true or not
Name
facetOnly
Type
boolean
Description
Flag to check Is facetOnly true or not
Name
includeFreeProduct
Type
boolean
Description
Flag to check is it includes free product or not
Name
includeExcludedBrand
Type
boolean
Description
Flag to check the inclusion of the excluded brand
Name
ignoreDisplayInSerach
Type
boolean
Description
Flag to check is ignoreDisplayInSerach true or not
Name
ignoreRollup
Type
boolean
Description
Flag to check Is ignoreRollup true or not
Name
promoCode
Type
string
Description
Promo code applied by the customer

Response attributes

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
booleanean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
object
Description
Result of the response
Name
recordId
Type
string
Description
Unique Id of the Product in Brand Record
Name
id
Type
string
Description
Product GUID identifier
Name
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
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
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
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
image
Type
string
Description
URL of the Image of the product
Name
images
Type
array
Description
Array containing the list of Images
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
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
imageTags
Type
array
Description
Tags associated with each Image
Name
name
Type
string
Description
Name of the attribute
Name
displayOrder
Type
number
Description
Order of the display associated with the product
Name
count
Type
number
Description
Count of the Item
Name
groups
Type
object
Description
Groups associated with the Item
Name
snippets
Type
array
Description
Additional code pieces to be added with the search
Name
slugType
Type
string
Description
Defines the type of slug

Request

POST

/api/v2/catalog/search/advanced/minimal

    curl --location --request POST 'https://api20.bettercommerce.io/api/v2/catalog/search/advanced/minimal' \
    --header 'Content-Type: application/x-www-form-urlencoded' \
    --header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597' \
    --data-urlencode 'freeText=red' \
    --data-urlencode 'currentPage=1' \
    --data-urlencode 'pageSize=20'

Response

{
    "statusCode": 200,
    "status": "OK",
    "errors": [],
    "success": true,
    "message": null,
    "messageCode": null,
    "result": {
        "total": 103,
        "pages": 6,
        "currentPage": 1,
        "prevPageUrl": null,
        "nextPageUrl": null,
        "sortList": [
            {
                "key": "1",
                "value": "Price : low to high"
            }
        ],
        "sortBy": "1",
        "images": null,
        "results": [
            {
                "recordId": "cfae6217-bc8b-4385-a561-b515a7cb283f",
                "name": "OUTBOUND 1st SIMPLE PRODUCT-English",
                "slug": "products/carl-hansen-outbound-1st-simple-product-ofsp001",
                "stockCode": "OFSP001",
                "listPrice": {
                    "minPrice": 0,
                    "minPriceWithoutTax": 0,
                    "maxPrice": 0,
                    "maxPriceWithoutTax": 0,
                    "currencyDecimalSeparator": null,
                    "currencyDigitsAfterDecimal": 0,
                    "currencySymbol": "£",
                    "formatted": {
                        "withTax": "£4.00",
                        "withoutTax": "£4.00",
                        "tax": "£1.00"
                    },
                    "raw": {
                        "withTax": 4,
                        "withoutTax": 4,
                        "tax": 1
                    }
                },
                "price": {
                    "minPrice": 3,
                    "minPriceWithoutTax": 3,
                    "maxPrice": 3,
                    "maxPriceWithoutTax": 3,
                    "currencyDecimalSeparator": null,
                    "currencyDigitsAfterDecimal": 0,
                    "currencySymbol": "£",
                    "formatted": {
                        "withTax": "£3.00",
                        "withoutTax": "£3.00",
                        "tax": "£0.00"
                    },
                    "raw": {
                        "withTax": 3,
                        "withoutTax": 3,
                        "tax": 0
                    }
                },
                "images": [
                    {
                        "name": "Image1",
                        "tag": null,
                        "image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/ob0.jpg?fm=webp",
                        "imageTypes": null,
                        "url": "https://liveocxstorage.blob.core.windows.net/betterstore/products/ob0.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/ob0.jpg?fm=webp",
                "itemType": 1,
                "shortDescription": "<p>OUTBOUND 1st SIMPLE PRODUCT description</p>\n",
                "subscriptionPlanType": 0,
                "groupName": null,
                "brand": "CARL HANSEN",
                "brandSlug": "brands/carl-hansen-9696",
                "subBrand": "",
                "sku": "OFSP001",
                "priceFrom": {
                    "minPrice": 3,
                    "minPriceWithoutTax": 3,
                    "maxPrice": 3,
                    "maxPriceWithoutTax": 3,
                    "currencyDecimalSeparator": null,
                    "currencyDigitsAfterDecimal": 0,
                    "currencySymbol": "£",
                    "formatted": {
                        "withTax": "£3.00",
                        "withoutTax": "£3.00",
                        "tax": "£0.00"
                    },
                    "raw": {
                        "withTax": 3,
                        "withoutTax": 3,
                        "tax": 0
                    }
                },
                "classification": {
                    "categoryId": "e5e49358-2d37-4d04-bd98-1ba87f2d1111",
                    "categoryCode": "e5e49358-2d37-4d04-bd98-1ba87f2d1111",
                    "mainCategoryId": "685d0abf-d352-4f9a-b9ce-07eeb781c905",
                    "mainCategoryName": "Bedding",
                    "category": "Comforter",
                    "itemTypeCode": null,
                    "itemType": "1",
                    "attributeSet": "Default Attribute set",
                    "attributeSetId": "227edf33-1894-43fe-acba-13c795c5c564"
                },
                "currentStock": 33,
                "description": "<p>OUTBOUND 1st SIMPLE PRODUCT description</p>\n",
                "attributes": [
                    {
                        "key": "global.gender",
                        "value": "male",
                        "display": "Gender"
                    }
                ],
                "fulfilFromWarehouse": true,
                "fulfilFromStore": false,
                "fulfilFromSupplier": false,
                "deliveryMessage": null,
                "stockAvailabilityMessage": null,
                "trending": false,
                "bestSeller": false,
                "onSale": false,
                "newLaunch": true,
                "exclusive": false,
                "extendedDescription": null,
                "variantProductsMinimal": null,
                "variantProductsAttributeMinimal": null,
                "isVisible": true,
                "isActive": false,
                "isMasterStock": true,
                "hasVariant": false,
                "promotions": null,
                "preOrder": {
                    "isEnabled": false,
                    "launchDateTime": "1900-01-01T00:00:00"
                },
                "seoName": "OUTBOUND 1st SIMPLE PRODUCT English"
            }
        ],
        "filters": [],
        "groups": null
    },
    "snippets": [],
    "slugType": 0
}

POST/api/v2/catalog/search/:freeText

Free text search result

This endpoint retrieves a search result by Free text.

Developers - API Operations:

Operation	Endpoint	Response
Free text search	`/api/v2/catalog/search/:freeText`	Free text search result

Required attributes

Name
freeText
Type
string
Description
Free Text input for the search operation

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
booleanean
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
products
Type
array
Description
List of the products in the collection
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
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
brands
Type
array
Description
Contains the brands for each collection

Request

POST

/api/v2/catalog/search/:freeText

curl --location --request POST 'https://api20.bettercommerce.io/api/v2/catalog/search/red' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
    "statusCode": 200,
    "status": "OK",
    "errors": [],
    "success": true,
    "message": null,
    "messageCode": null,
    "result": {
        "products": [
            {
                "name": "White And Red Lobster Print Blouse",
                "image": "https://liveocxstorage.blob.core.windows.net/betterstore/ex21425_white_1227.webp?fm=webp",
                "slug": "products/my-brand-white-red-lobster-print-blouse-bs21425-redprnt-14",
                "price": {
                    "minPrice": 49.99,
                    "minPriceWithoutTax": 49.99,
                    "maxPrice": 49.99,
                    "maxPriceWithoutTax": 49.99,
                    "currencyDecimalSeparator": null,
                    "currencyDigitsAfterDecimal": 0,
                    "currencySymbol": "£",
                    "formatted": {
                        "withTax": "£49.99",
                        "withoutTax": "£49.99",
                        "tax": "£0.00"
                    },
                    "raw": {
                        "withTax": 49.99,
                        "withoutTax": 49.99,
                        "tax": 0
                    }
                }
            }
        ],
        "categories": [],
        "blogs": [],
        "brands": []
    }
}

POST/api/v2/catalog/search/suggestion/:freeText

Search suggestion based on free text

This endpoint retrieves search suggestions based on the free text provided.

Developers - API Operations:

Operation	Endpoint	Response
Search suggestions	`/api/v2/catalog/search/suggestion/:freeText`	Search suggestions based on free text provided

Required attributes

Name
freeText
Type
string
Description
Free Text input for the search operation

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
booleanean
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
suggestion
Type
string
Description
Suggestion value that enhance search results
Name
object
Type
object
Description
Contains attributes related to the suggestion provided

Request

POST

/api/v2/catalog/search/suggestion/:freeText

curl --location --request POST 'https://api20.bettercommerce.io/api/v2/catalog/search/suggestion/red' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'```

```js
    import ApiClient from '@example/protocol-api'

    const client = new ApiClient(token)

    await client.messages.list()

Response

{
    "statusCode": 200,
    "status": "OK",
    "errors": [],
    "success": true,
    "message": null,
    "messageCode": null,
    "result": [
        {
            "suggestion": "RED",
            "object": null
        }
    ]
}

GET/api/v2/catalog/search/keyword-redirections

Get keyword redirection rules

This endpoint retrieves keyword redirection rules.

Developers - API Operations:

Operation	Endpoint	Response
Keyword redirection rule	`/api/v2/catalog/search/keyword-redirections`	Get keyword redirection rules

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
booleanean
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
keywords
Type
string
Description
keywords that enhance search results
Name
url
Type
string
Description
Url matched with keyword provided

Request

GET

/api/v2/catalog/search/keyword-redirections

curl --location --request GET 'https://api20.bettercommerce.io/api/v2/catalog/search/keyword-redirections' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
    "statusCode": 200,
    "status": "OK",
    "errors": [],
    "success": true,
    "message": null,
    "messageCode": null,
    "result": [
        {
            "keywords": "black top",
            "url": "https://betterstore.bettercommerce.tech/products/my-brand-cotton-racerback-spaghetti-top-women-black-1-bs0010-black-s"
        }
    ]
}