Lookbook

A lookbook is a collection of photographs or other visuals that displays a brand's line of products. On this page, we'll dive into the different Lookbook endpoints you can use to manage all your Lookbook collection programmatically.

"currencies": [
  {
    "name": "string",
    "currencyCode": "string",
    "currencySymbol": "string"
  }
]

GET/api/v2/catalog/lookbook

Get all lookbooks

This endpoint allows you to retrieve a list of all the Lookbook defined.

Developers - API Operations:

Operation	Endpoint	Response
All Lookbook Collection	`/api/v2/catalog/lookbook`	Get all collection of Lookbook.

Required attributes

Name
stockCode
Type
string
Description
Unique id of the stock

Response Properties

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
object
Description
Result of the response
Name
id
Type
string
Description
Id of the Collection
Name
name
Type
string
Description
Name of the Collection
Name
groupName
Type
string
Description
Name of lookbook collection / group name
Name
description
Type
string
Description
The new description for the group
Name
slug
Type
string
Description
Link associated with each lookbook
Name
mainImage
Type
string
Description
Main Image Url of the Product
Name
customInfo1
Type
array
Description
Array containing customInfo1 values
Name
customInfo2
Type
array
Description
Array containing customInfo2 values
Name
customInfo3
Type
array
Description
Array containing customInfo3 values

Request

GET

/api/v2/catalog/lookbook

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

Response

{
"statusCode": 200,
"status": "OK",
"errors": [],
"success": true,
"message": null,
"messageCode": null,
"result": [
    {
        "id": "6d2e3656-206b-46ec-bc40-ad5f00776fc3",
        "name": "A Spring Day",
        "groupName": "",
        "description": "2021AVE·It's all about cute summer outfits. Summer is here and it's time to celebrate with summer clothes for women. From vacation looks to beach day outfits, we've got your summer fashion inspo.\nBeige lounge shorts and white ribbed tank #loungewear #ootd #comfystyle",
        "slug": "lookbook/A Spring Day",
        "mainImage": "https://liveocxstorage.blob.core.windows.net/betterstore/lookbook/lookbook3.webp",
        "customInfo1": "",
        "customInfo2": "",
        "customInfo3": ""
    }]
}

GET/api/v2/catalog/lookbook/:groupName

Get lookbooks by collection / group name

This endpoint retrieves a Lookbok based on the collection or groupName passed.

Developers - API Operations:

Operation	Endpoint	Response
Lookbook by Collection	`/api/v2/catalog/lookbook/:groupName`	Get all the Collection by groupName or collection.

Required attributes

Name
groupName
Type
string
Description
Name of lookbook collection / group name

Response Properties

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
object
Description
Result of the response
Name
id
Type
string
Description
Id of the Collection
Name
name
Type
string
Description
Name of the Collection
Name
groupName
Type
string
Description
Name of lookbook collection / group name
Name
description
Type
string
Description
The new description for the group
Name
slug
Type
string
Description
Link associated with each lookbook
Name
mainImage
Type
string
Description
Main Image Url of the Product
Name
customInfo1
Type
array
Description
Array containing customInfo1 values
Name
customInfo2
Type
array
Description
Array containing customInfo2 values
Name
customInfo3
Type
array
Description
Array containing customInfo3 values

Request

GET

/api/v2/catalog/lookbook/:groupName

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

Response

{
"statusCode": 200,
"status": "OK",
"errors": [],
"success": true,
"message": null,
"messageCode": null,
"result": [
    {
        "id": "6d8448b1-0d4c-4d83-801d-adc000aea56a",
        "name": "Summer Staples",
        "groupName": "add",
        "description": "Shop our highly anticipated summer collection now, which marries luxe and street-style, designed to elevate your day to night look. Consisting of flattering shapes to complement every figure, our new collection is available in a mixture of prints, which are not for the faint-hearted. The iconic animal print makes a bold return in this collection, with snakeskin, zebra and tiger print at the core of this edit; offered in beautiful fabrics including silk, PVC and faux fur. We dare you to wal",
        "slug": "lookbook/summer-staples",
        "mainImage": "https://liveocxstorage.blob.core.windows.net/betterstore/lookbook/taradropone36.jpg",
        "customInfo1": "",
        "customInfo2": "",
        "customInfo3": ""
    }
]
}

GET/api/v2/catalog/lookbook/slug?slug={{variable_slug}}

Get lookbook by slug

This endpoint retrieves a collection based on the Slug passed.

Developers - API Operations:

Operation	Endpoint	Response
Lookbook by Slug	`/api/v2/catalog/lookbook/slug?slug={{variable_slug}}`	Get the Lookbook collection by slug.

Required attributes

Name
slug
Type
string
Description
Unique slug for each Collection.

Response Properties

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
object
Description
Result of the response
Name
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 product
Name
recordId
Type
string
Description
Id of the Product in Brand Record
Name
stockCode
Type
string
Description
Stock code of the product
Name
name
Type
string
Description
Name of the product
Name
slug
Type
string
Description
Slug of the product used to navigate to the product
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
images
Type
array
Description
Array of Images.
Name
image
Type
string
Description
URL of the product image
Name
tag
Type
string
Description
Tag associated with the Product
Name
url
Type
string
Description
URL of the Image
Name
mobileUrl
Type
string
Description
URL for mobile
Name
alt
Type
string
Description
Alternate text to be added in Image
Name
link
Type
string
Description
Link of the product
Name
description
Type
string
Description
Description of the product
Name
subTitle
Type
string
Description
Subtitle of the Category
Name
linkType
Type
string
Description
Name of the Logo Image
Name
buttonText
Type
string
Description
Text to be added in button
Name
eventCategory
Type
string
Description
Category of the event
Name
eventAction
Type
string
Description
Action of the event
Name
gaValue
Type
string
Description
Value of the GA data
Name
isActive
Type
boolean
Description
Flag to check the Active status
Name
displayOrder
Type
number
Description
Order of the display associated with the product
Name
imageTags
Type
array
Description
Tags associated with each Image
Name
shortDescription
Type
string
Description
Short description of the product
Name
subscriptionPlanType
Type
string
Description
Type of the subscription plan
Name
brand
Type
string
Description
Name of the brand
Name
brandSlug
Type
string
Description
Slug of the brand
Name
subBrand
Type
string
Description
SubBrand of parent Brand
Name
categoryId
Type
string
Description
Category Id
Name
categoryCode
Type
string
Description
Category Code
Name
mainCategoryId
Type
string
Description
Main category Id
Name
category
Type
string
Description
Category of the product
Name
itemTypeCode
Type
string
Description
Code for the itemType
Name
attributeSetId
Type
string
Description
Id for each of the attributes
Name
fulfillFromStore
Type
boolean
Description
Flag to check is fulfilFromStore or not
Name
fulfillFromSupplier
Type
boolean
Description
Flag to check is fulfilFromSupplier or not
Name
deliveryMessage
Type
string
Description
Message for the delivery
Name
stockAvailabilityMessage
Type
string
Description
Message to check stock availability
Name
trending
Type
boolean
Description
Is Product trending or not
Name
bestSeller
Type
boolean
Description
Is Product bestSeller or not
Name
onSale
Type
boolean
Description
Is Product onSale or not
Name
newLaunch
Type
boolean
Description
Is Product newly launched or not
Name
exclusive
Type
boolean
Description
Is Product exclusiv or not
Name
extendedDescription
Type
string
Description
Extended description of the product
Name
variantProductsMinimal
Type
array
Description
Minimal variant products array
Name
variantProductsAttributeMinimal
Type
array
Description
Minimal variant products attribute array
Name
isVisible
Type
boolean
Description
Flag to check is visible enabled or not
Name
isMasterStock
Type
boolean
Description
Flag to check Is master stock or not
Name
hasVariant
Type
boolean
Description
Flag to check Is variant available or not
Name
promotions
Type
array
Description
Array containing attributes for promotions
Name
preOrder
Type
array
Description
Array containing attributes for order
Name
isEnabled
Type
boolean
Description
Flag to check Is order enabled or not
Name
launchDateTime
Type
string
Description
Launch & date time of the order
Name
filters
Type
array
Description
Filters to be applied
Name
groups
Type
array
Description
Groups where the product belongs
Name
subBrands
Type
array
Description
Contains the subBrands of each Brands
Name
categories
Type
array
Description
Contains the categories
Name
subcategories
Type
array
Description
Contains the subcategories of each category
Name
blogs
Type
array
Description
Contains the blogs of each category
Name
metaTitle
Type
string
Description
MetaTitle associated with the product
Name
metaDescription
Type
string
Description
MetaDescription associated with the product
Name
metaKeywords
Type
string
Description
MetaKeywords associated with the product
Name
canonicalTags
Type
string
Description
Cannonical Tags associated with the product
Name
allowFacets
Type
boolean
Description
Flag to check Is allowFacets true or not
Name
filterCriteria
Type
string
Description
Criteria for filtering
Name
attributeType
Type
string
Description
Defines the type of attribute
Name
groupId
Type
string
Description
Unique Id of the group containing the product
Name
pageSize
Type
string
Description
Size of the page
Name
displayTitle
Type
boolean
Description
Flag to allow title to be displayed or not
Name
customInfo1
Type
array
Description
Array containing customInfo1 values
Name
customInfo2
Type
array
Description
Array containing customInfo2 values
Name
customInfo3
Type
array
Description
Array containing customInfo3 values
Name
customFieldValue
Type
string
Description
String containing customFieldValue
Name
customFieldDisplayOrder
Type
string
Description
String containing customFieldDisplayOrder
Name
mainImage
Type
string
Description
Main Image Url of the Product
Name
image1
Type
string
Description
Image1 Url of the Product
Name
image2
Type
string
Description
Image2 Url of the Product
Name
image3
Type
string
Description
Image3 Url of the Product
Name
image4
Type
string
Description
Image4 Url of the Product
Name
displayGroupName
Type
string
Description
Image4 Url of the Product
Name
imageBy
Type
string
Description
Image source title
Name
createdBy
Type
string
Description
Product created by
Name
customLinks
Type
string
Description
Custom links for the product
Name
snippets
Type
array
Description
Array containing additional code pieces to be added with the category
Name
slugType
Type
string
Description
Defines the type of slug

Request

POST

/api/v2/catalog/collection/slug?slug={{variable_slug}}

curl --location --request GET 'https://api20.bettercommerce.io/api/v2/catalog/lookbook/slug?slug=lookbook/an-ideal-day' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
    "statusCode": 200,
    "status": "OK",
    "errors": [],
    "success": true,
    "message": null,
    "messageCode": null,
    "result": {
        "products": {
            "total": 5,
            "pages": 1,
            "currentPage": 1,
            "prevPageUrl": null,
            "nextPageUrl": null,
            "sortList": [
                {
                    "key": "1",
                    "value": "Price : low to high"
                }
            ],
            "sortBy": "1",
            "images": [],
            "results": [
                {
                    "recordId": "c5c88b09-e39a-476a-9523-bac53e75a212",
                    "name": "SUPERELLIPS",
                    "slug": "products/kallemo-superellips-lb003",
                    "stockCode": "LB003",
                    "listPrice": {
                        "minPrice": 0,
                        "minPriceWithoutTax": 0,
                        "maxPrice": 0,
                        "maxPriceWithoutTax": 0,
                        "currencyDecimalSeparator": null,
                        "currencyDigitsAfterDecimal": 0,
                        "currencySymbol": "£",
                        "formatted": {
                            "withTax": "£0.00",
                            "withoutTax": "£0.00",
                            "tax": "£-16000.00"
                        },
                        "raw": {
                            "withTax": 0,
                            "withoutTax": 0,
                            "tax": -16000
                        }
                    },
                    "price": {
                        "minPrice": 16000,
                        "minPriceWithoutTax": 16000,
                        "maxPrice": 16000,
                        "maxPriceWithoutTax": 16000,
                        "currencyDecimalSeparator": null,
                        "currencyDigitsAfterDecimal": 0,
                        "currencySymbol": "£",
                        "formatted": {
                            "withTax": "£16000.00",
                            "withoutTax": "£16000.00",
                            "tax": "£0.00"
                        },
                        "raw": {
                            "withTax": 16000,
                            "withoutTax": 16000,
                            "tax": 0
                        }
                    },
                    "images": [
                        {
                            "name": "Image1",
                            "tag": null,
                            "image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/lb005.webp?fm=webp",
                            "imageTypes": null,
                            "url": "https://liveocxstorage.blob.core.windows.net/betterstore/products/lb005.webp?fm=webp",
                            "mobileUrl": null,
                            "alt": null,
                            "link": null,
                            "description": null,
                            "subTitle": null,
                            "linkType": null,
                            "buttonText": null,
                            "eventCategory": null,
                            "eventAction": null,
                            "gaValue": null,
                            "isActive": false,
                            "cssClass": null,
                            "title": null,
                            "displayOrder": 0,
                            "imageTags": []
                        }
                    ],
                    "image": "https://liveocxstorage.blob.core.windows.net/betterstore/products/lb005.webp?fm=webp",
                    "itemType": 1,
                    "shortDescription": "<p>Superellips &auml;r ett klassiskt bord fr&aring;n Fritz Hansen, formgivet &aring;r 1968 genom ett samarbete mellan Piet Hein, Bruno Mathsson och Arne Jacobsen. Den superelliptiska bordsskivan finns i tv&aring; varianter, laminat med aluminiumkl&auml;dd kant alternativt helt i valn&ouml;tsfan&eacute;r. Laminatskivan finns i flera olika f&auml;rger och &auml;r gjord i det s&auml;rskilt slitstarka materialet fenixlaminat,&nbsp;vilket Fritz Hansen introducerade f&ouml;r&nbsp;Superellips &aring;r 2017.&nbsp;Fenixlaminat&nbsp;inneb&auml;r en extra matt och rept&aring;lig yta p&aring; bordsskivan. Benen best&aring;r av avtagbara sp&auml;nnben i st&aring;l och finns med f&ouml;rkromad eller pulverlackerad yta i vit, svart eller gr&aring; kul&ouml;r. Superellips finns &auml;ven med utdragbar bordsskiva.&nbsp;</p>\n\n<p>Inspirationen bakom Superellips kommer fr&aring;n Piet Heins genialiska l&ouml;sning p&aring; ett trafikproblem vid Sergels torg i Stockholm, en superelliptisk rondell. Superellips har kommit att bli ett av Skandinaviens mest v&auml;lk&auml;nda bord och en riktig designikon fr&aring;n Fritz Hansen.</p>\n",
                    "subscriptionPlanType": 0,
                    "groupName": null,
                    "brand": "KÄLLEMO",
                    "brandSlug": "brands/kallemo-9693",
                    "subBrand": "",
                    "sku": "LB003",
                    "priceFrom": {
                        "minPrice": 16000,
                        "minPriceWithoutTax": 16000,
                        "maxPrice": 16000,
                        "maxPriceWithoutTax": 16000,
                        "currencyDecimalSeparator": null,
                        "currencyDigitsAfterDecimal": 0,
                        "currencySymbol": "£",
                        "formatted": {
                            "withTax": "£16000.00",
                            "withoutTax": "£16000.00",
                            "tax": "£0.00"
                        },
                        "raw": {
                            "withTax": 16000,
                            "withoutTax": 16000,
                            "tax": 0
                        }
                    },
                    "classification": {
                        "categoryId": "9d87e15b-dcd3-48e6-b7e1-cbafe16b9fce",
                        "categoryCode": "9d87e15b-dcd3-48e6-b7e1-cbafe16b9fce",
                        "mainCategoryId": "9d87e15b-dcd3-48e6-b7e1-cbafe16b9fce",
                        "mainCategoryName": "Furniture",
                        "category": "Furniture",
                        "itemTypeCode": null,
                        "itemType": "1",
                        "attributeSet": "Furniture",
                        "attributeSetId": "c084a603-6399-4ca0-a681-f8a5f1072ffc"
                    },
                    "currentStock": 456,
                    "description": "<p>Superellips &auml;r ett klassiskt bord fr&aring;n Fritz Hansen, formgivet &aring;r 1968 genom ett samarbete mellan Piet Hein, Bruno Mathsson och Arne Jacobsen. Den superelliptiska bordsskivan finns i tv&aring; varianter, laminat med aluminiumkl&auml;dd kant alternativt helt i valn&ouml;tsfan&eacute;r. Laminatskivan finns i flera olika f&auml;rger och &auml;r gjord i det s&auml;rskilt slitstarka materialet fenixlaminat,&nbsp;vilket Fritz Hansen introducerade f&ouml;r&nbsp;Superellips &aring;r 2017.&nbsp;Fenixlaminat&nbsp;inneb&auml;r en extra matt och rept&aring;lig yta p&aring; bordsskivan. Benen best&aring;r av avtagbara sp&auml;nnben i st&aring;l och finns med f&ouml;rkromad eller pulverlackerad yta i vit, svart eller gr&aring; kul&ouml;r. Superellips finns &auml;ven med utdragbar bordsskiva.&nbsp;</p>\n\n<p>Inspirationen bakom Superellips kommer fr&aring;n Piet Heins genialiska l&ouml;sning p&aring; ett trafikproblem vid Sergels torg i Stockholm, en superelliptisk rondell. Superellips har kommit att bli ett av Skandinaviens mest v&auml;lk&auml;nda bord och en riktig designikon fr&aring;n Fritz Hansen.</p>\n",
                    "attributes": [],
                    "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": ""
                }
            ],
            "filters": [],
            "groups": null
        },
        "id": "34cc53d0-16f4-4b6e-a07b-ae0c00d571f4",
        "name": "My Ideal Home",
        "listType": 9,
        "brands": null,
        "subBrands": null,
        "categories": null,
        "subCategories": null,
        "images": [],
        "blogs": null,
        "metaTitle": "betterstore",
        "metaDescription": "betterstore",
        "metaKeywords": "betterstore",
        "canonicalTags": "",
        "allowFacets": false,
        "filters": [],
        "filterCriteria": [],
        "pageSize": 20,
        "sortBy": "0",
        "link": null,
        "groupSeparator": "",
        "groupCode": "",
        "displayTitle": false,
        "groups": null,
        "customInfo1": "",
        "customInfo2": "",
        "customInfo3": "",
        "customFieldValue": "",
        "customFieldDisplayOrder": "",
        "description": "My ideal home is a personalized handpicked furniture items set that gives you the touch of royalty and the feel of contemporary world yet keeping your living area cool and peace making.",
        "mainImage": "https://liveocxstorage.blob.core.windows.net/betterstore/lookbook/lbbb.jfif",
        "image1": "https://liveocxstorage.blob.core.windows.net/betterstore/lookbook/lb005.webp",
        "image2": "https://liveocxstorage.blob.core.windows.net/betterstore/lookbook/lb006.webp",
        "image3": "https://liveocxstorage.blob.core.windows.net/betterstore/lookbook/lb004.webp",
        "image4": "https://liveocxstorage.blob.core.windows.net/betterstore/lookbook/lb001.webp",
        "imageAnnotationsJson": "",
        "imageAnnotationsJson1": "",
        "imageAnnotationsJson2": "",
        "imageAnnotationsJson3": "",
        "imageAnnotationsJson4": "",
        "displayGroupName": null,
        "imageBy": 1,
        "createdBy": "sanjay.kumar@omnicx.com",
        "customLinks": [],
        "categoryId": 0
    },
    "snippets": null,
    "slugType": 7
}