Catalog

Manages product catalogs, including adding, updating, and deleting products, as well as categorizing them.

Brand

A brand represents a specific brand or manufacturer associated with a product. Brands help customers identify and differentiate products based on their manufacturer or designer. Each brand typically has a unique identifier and a name. For example, a clothing platform might have brands such as Nike, Adidas, Gucci, Zara, etc. Brand APIs facilitate access to brand-related data, offering functionalities such as retrieving list of available brands and obtaining detailed information about a specific brand using its unique slug.

Operations
GET
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/brand
# List sales channel brands
PATCH
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/brand/{brand_uid}
# Update sales channel brand
GET
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/brands
# List brands
GET

List sales channel brands

Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search query with brand name. Use this parameter to search brands by brand name.
Response
200
List of Brands.
ApplicationBrandListingSchema
items
array of object (ApplicationBrandListingItemSchema)
Array of ApplicationBrandListingItemSchema
_custom_json
object
Custom JSON object for additional data.
_locale_language
object
Custom object for locale-specific language data.
Default Value : [object Object]
brand_banner_portrait_url
string
URL of the brand's portrait banner.
brand_banner_url
string
URL of the brand's landscape banner.
brand_logo_url
string
URL of the brand's logo.
description
string
Description of the brand.
name
string
Name of the brand.
slug_key
string
Unique slug key for the brand.
priority
integer
Priority of the brand in listing.
uid
integer
Unique identifier of the brand.
created_on
string
| date-time
Timestamp when the category was created.
last_updated
string
| date-time
Timestamp when the category was created.
is_active
boolean
Indicates if the brand is active.
departments
array of integer
List of department IDs associated with the brand.
modified_on
string
| date-time
Timestamp when the brand was last modified.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
Parameters are not required.
GET
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/brand
Loading...
Response
Loading...
PATCH

Update sales channel brand

Modify data associated to the brand for that particular sales channel.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
brand_uid
integer
Required
A `brand id` is a unique identifier for a particular brand.
Request body
_custom_json
object
Required
A custom JSON object containing additional brand-specific configurations or data. The structure is flexible and may vary based on application needs.
Response
200
Returns a success response
SuccessResponseObject
success
boolean
Indicates whether the operation was successful or not.
uid
integer
A unique identifier associated with the successful operation.
Examples
Parameters
body:
body
PATCH
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/brand/{brand_uid}
Loading...
Response
Loading...
GET

List brands

List all the brands.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
department
string
The name of the department. Use this parameter to filter products by a particular department. See below the list of available departments. You can retrieve available departments from the "v1.0/departments/" API
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search query with brand name. Use this parameter to search brands by brand name.
brand_id
array of integer
Helps to sort the brands list on the basis of uid list.
Response
200
List of Brands.
BrandListingResponseSchema
items
array of object (BrandItem)
An array of brand items, each containing detailed information about the brand, such as action, banners, departments, discount, logo, and other related fields.
Array of BrandItem
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
departments
array of string
An array of department names or categories that the brand belongs to, represented as strings.
discount
string
A string representing the discount offered by the brand, such as percentage or amount off.
logo
object (BrandMedia)
BrandMedia
aspect_ratio
string
The aspect ratio of the media, typically represented as a string like '16:9' or '4:3'.
type
string
The type of media, such as 'image', 'video', or 'audio', describing the content format.
url
string
The URL where the media file is hosted, typically a link to an image or video resource.
name
string
The name of the brand.
slug
string
A URL-friendly identifier for the brand, often used in website routing.
uid
integer
A unique identifier for the brand, typically used for internal reference.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
department:
"kids"
page_no:
1
page_size:
1
q:
"test"
brand_id:
2
GET
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/brands
Loading...
Response
Loading...

Category

Categories are hierarchical structure that enables a systematic organization of products for better discoverability of products on storefront. Categories are structured into three levels: L1, L2, and L3, with L1 representing the top-level category, followed by L2 and L3. For example - Clothing(L1) >> Shirts(L2) >> Formal Shirts(L3) A single L1 category can encompass multiple L2 categories underneath it, and similarly, an L2 category can contain multiple L3 categories within it. Category is a sales-channel specific configuration. While categories are common across all companies, sales channel can configure L3 category names tailored to their unique requirements.

Operations
GET
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/categories
# List categories
GET
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/category
# List sales channel categories
PATCH
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/category/{category_uid}
# Update sales channel category
GET

List categories

Retrieve a list of categories associated to company and sales channel. user can filter on departments.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
department
string
The name of the department. Use this parameter to filter products by a particular department. See below the list of available departments. You can retrieve available departments from the "v1.0/departments/" API
Response
200
List of Categories.
CategoryListingResponseSchema
data
array of object (DepartmentCategoryTree)
An array containing the department category trees, which provide hierarchical information about categories and their associated departments.
Array of DepartmentCategoryTree
department
string
The name of the department that this category tree belongs to, such as 'Men', 'Women', or 'Electronics'.
items
array of object (CategoryItems)
An array of categories that fall under the specified department, each containing details about category items.
Array of CategoryItems
_custom_json
object
Nullable
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
childs
array of object (Child)
Array of Child
_custom_json
object
Custom JSON object to store additional data for the child.
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
childs
array of object (SecondLevelChild)
A list of second-level child elements under the current child.
Array of SecondLevelChild
_custom_json
object
Custom JSON object to store additional data for the second-level child.
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
childs
array of object (ThirdLevelChild)
A list of third-level child elements under the second-level child.
Array of ThirdLevelChild
_custom_json
object
Custom JSON object to store additional data for the third-level child.
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
childs
array of object
A list of further nested child elements under the third-level child (if applicable).
name
string
Name of the third-level child element.
slug
string
Slug or URL-friendly identifier for the third-level child element.
uid
integer
Unique identifier for the third-level child element.
name
string
Name of the second-level child element.
slug
string
Slug or URL-friendly identifier for the second-level child element.
uid
integer
Unique identifier for the second-level child element.
name
string
Name of the child element.
slug
string
Slug or URL-friendly identifier for the child element.
uid
integer
Unique identifier for the child element.
name
string
slug
string
uid
integer
departments
array of object (DepartmentIdentifier)
An array of department identifiers, each providing basic information like name, slug, and unique ID for departments within the catalog.
Array of DepartmentIdentifier
name
string
The name of the department, such as 'Electronics', 'Apparel', or 'Home Appliances'.
slug
string
A URL-friendly identifier for the department, often used in creating department-specific links or routes.
uid
integer
A unique identifier for the department, used to distinguish it from other departments in the system.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
department:
"kids"
GET
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/categories
Loading...
Response
Loading...
GET

List sales channel categories

Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
department_id
integer
A `department_id` is a unique identifier for a particular department.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
A search query string. Use this parameter to filter results based on a keyword or specific value.
Response
200
List of Categories.
ApplicationCategoryListingSchema
items
array of object (ApplicationCategoryListingItemSchema)
Array of ApplicationCategoryListingItemSchema
name
string
Name of the category.
logo
string
URL of the category's logo.
departments
array of integer
List of department IDs.
attr_name
string
Attribute name of the category.
landscape_url
string
URL of the landscape banner.
portrait_url
string
URL of the portrait banner.
_custom_json
object
Custom JSON object for additional data.
priority
integer
Priority of the category.
created_by
object (CreatedBy)
CreatedBy
user_id
string
Unique identifier for the user.
username
string
Username of the user who created the product.
created_on
string
| date-time
Timestamp when the category was created.
modified_by
object (CreatedBy)
CreatedBy
user_id
string
Unique identifier for the user.
username
string
Username of the user who created the product.
modified_on
string
| date-time
Timestamp when the category was last modified.
app_id
string
Application ID associated with the category.
is_active
boolean
Indicates whether the category is active.
uid
integer
Unique identifier of the category.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
department_id:
1
page_no:
1
page_size:
1
q:
"test"
GET
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/category
Loading...
Response
Loading...
PATCH

Update sales channel category

Modify category data related to the sales channel .
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
category_uid
string
Required
A `category id` is a unique identifier for a particular category.
Request body
_custom_json
object
Required
A custom JSON object containing additional details or configurations specific to the application category.
Response
200
Returns a success response
SuccessResponseObject
success
boolean
Indicates whether the operation was successful or not.
uid
integer
A unique identifier associated with the successful operation.
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
category_uid:
1
body:
body
PATCH
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/category/{category_uid}
Loading...
Response
Loading...

Collection

The Collection is grouping of products together within an e-commerce platform, enabling sellers to curate and showcase these collections on the product listing page. Collections serve as a means to organize and highlight related products. Two types of collections basic and handpicked collections are availble. Basic Collections: These collections are configured based on predefined criteria such as brand, category, department, or a combination thereof. Sellers can create basic collections to showcase products that share common attributes.For example, a basic collection can include all products from a specific brand, a particular category, or a combination of brands and categories. Handpicked Collections: In contrast to basic collections, handpicked collections allow sellers to manually select products regardless of their categorization. This type of collection enables sellers to curate unique assortments that may not fit within predefined categories or brands. Sellers have the flexibility to include products based on their individual preferences, promotions, or seasonal themes, creating curated collections that resonate with their target audience.

Operations
GET
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/
# List collections
POST
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/
# Create a collection
DEL
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{id}/
# Delete a collection
PUT
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{id}/
# Update a collection
GET
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{id}/items/
# List items of collection
POST
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{id}/items/
# Create items in a collection
GET
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{slug}/
# Get a collection
GET

List collections

Retrieve all collections based on criteria such as collection name, schedule status, and active status.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
q
string
Get collection list filtered by q string,
schedule_status
string
Get collection list filtered by scheduled status,
Enum
type
string
Type of the collections
tags
array of string
Each response will contain next_id param, which should be sent back to make pagination work.
is_active
boolean
Get collections filtered by active status.
page_no
integer
The page number to navigate through the given set of results.
page_size
integer
Number of items to retrieve in each page. Default is 12.
Response
200
List of collections.
GetCollectionListingResponseSchema
filters
object (CollectionListingFilter)
CollectionListingFilter
tags
array of object (CollectionListingFilterTag)
A list of tags used to filter the collection listing.
Array of CollectionListingFilterTag
display
string
The display name of the tag for the collection listing.
is_selected
boolean
Indicates whether the tag is currently selected.
name
string
The name of the tag.
type
array of object (CollectionListingFilterType)
A list of types used to filter the collection listing.
Array of CollectionListingFilterType
display
string
The display name of the type for the collection listing.
is_selected
boolean
Indicates whether the type is currently selected.
name
string
The internal name of the type.
items
array of object (GetCollectionDetailNest)
Array of nested collection details.
Array of GetCollectionDetailNest
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
The cron expression that defines the scheduling pattern, allowing for tasks or events to be repeated at specific intervals (e.g., daily, weekly).
duration
integer
Nullable
The duration in seconds for which the collection is active or valid.
end
string
| date-time
Nullable
The end date and time for the collection's schedule, formatted as a date-time string.
next_schedule
array of object (NextSchedule)
The next set of scheduled times when the collection will become active, based on the cron expression.
Array of NextSchedule
end
string
| date-time
Nullable
The end time of the schedule.
start
string
| date-time
The start time of the schedule.
start
string
| date-time
The start date and time for the collection's schedule, formatted as a date-time string.
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
allow_facets
boolean
Indicates whether facets are allowed for filtering the collection.
allow_sort
boolean
Indicates whether sorting options are allowed for the collection.
app_id
string
The application ID associated with the collection.
badge
object (CollectionBadge)
CollectionBadge
color
string
The color of the badge displayed with the collection, typically represented as a string (e.g., a hex code or color name).
text
string
The text displayed on the badge, which may indicate a label or promotion related to the collection.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
cron
object
description
string
A description of the collection.
is_active
boolean
Indicates whether the collection is currently active.
logo
object (Media)
Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
meta
object
Additional metadata related to the collection.
name
string
The name of the collection.
priority
integer
The priority level of the collection in the display list.
query
array of object (CollectionQuery)
Array of queries that define how the collection is fetched or filtered.
Array of CollectionQuery
attribute
string
The attribute of the collection query
op
string
The operation to be performed on the attribute of the collection query
Enum
value
array of Undefined Type
The value of the attribute of the collection query
slug
string
The URL-friendly identifier of the collection.
tag
array of string
Array of tags associated with the collection.
type
string
The type of collection, such as manual or automated.
uid
string
The unique identifier for the collection.
visible_facets_keys
array of string
List of facet keys that are visible for filtering the collection.
_id
string
Internal identifier for the collection.
published
boolean
Indicates if the collection is published.
tags
array of string
Tags associated with the collection.
sort_on
string
Sort criteria for the collection.
_custom_json
object
Custom JSON data for the collection.
_locale_language
object
Locale-specific language settings.
seo
object (SeoDetail)
SeoDetail
description
string
SEO meta description for the item or collection. This is used to describe the content for search engines.
title
string
SEO meta title for the item or collection. It is used as the title that appears in search results.
sitemap
object
Information regarding the sitemap configuration for the item or collection.
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
List of breadcrumbs for navigation, showing the hierarchy of pages leading to the current page.
Array of ApplicationItemSeoBreadcrumbs
url
string
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (Metatags)
An array of meta tags, each containing key-value pairs for various SEO meta tags used to enhance search visibility.
Array of Metatags
title
string
The title or heading for the meta tags section.
items
array of object (ApplicationItemSeoMetaTagItem)
An array of meta tag items, each consisting of key-value pairs.
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
The canonical URL for the item or collection, which tells search engines the preferred version of the URL to avoid duplicate content issues.
is_visible
boolean
Indicates if the collection is visible.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
application_id:
"64c00b72c07acacc1357503b"
q:
"test"
schedule_status:
"live"
type:
"query"
tags:
"Test Collection 123"
is_active:
true
page_no:
1
page_size:
1
GET
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/
Loading...
Response
Loading...
POST

Create a collection

Create a collection for a sales channel linked to a company.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
q
string
Get collection list filtered by q string,
schedule_status
string
Get collection list filtered by scheduled status,
Enum
type
string
Type of the collections
tags
array of string
Each response will contain next_id param, which should be sent back to make pagination work.
is_active
boolean
Get collections filtered by active status.
page_no
integer
The page number to navigate through the given set of results.
page_size
integer
Number of items to retrieve in each page. Default is 12.
Request body
_custom_json
object
Custom JSON data for the collection, used for any additional information.
Default Value : [object Object]
_locale_language
object
Locale-specific data for supporting multiple languages.
Default Value : [object Object]
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
The cron expression that defines the scheduling pattern, allowing for tasks or events to be repeated at specific intervals (e.g., daily, weekly).
duration
integer
Nullable
The duration in seconds for which the collection is active or valid.
end
string
| date-time
Nullable
The end date and time for the collection's schedule, formatted as a date-time string.
next_schedule
array of object (NextSchedule)
The next set of scheduled times when the collection will become active, based on the cron expression.
Array of NextSchedule
end
string
| date-time
Nullable
The end time of the schedule.
start
string
| date-time
The start time of the schedule.
start
string
| date-time
The start date and time for the collection's schedule, formatted as a date-time string.
allow_facets
boolean
Indicates whether facet-based filtering is allowed for the collection.
Default Value : true
allow_sort
boolean
Indicates whether sorting options are allowed for the collection.
Default Value : true
app_id
string
Required
The application ID associated with the collection.
badge
object (CollectionBadge)
CollectionBadge
color
string
The color of the badge displayed with the collection, typically represented as a string (e.g., a hex code or color name).
text
string
The text displayed on the badge, which may indicate a label or promotion related to the collection.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
banners
object (CollectionBanner)
Required
CollectionBanner
landscape
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
Required
The aspect ratio of the image, typically represented as a string (e.g., "16:9" or "4:3") to indicate the proportional relationship between the image's width and height.
url
string
Required
The URL of the image, which provides the location where the image is hosted and can be accessed.
portrait
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
Required
The aspect ratio of the image, typically represented as a string (e.g., "16:9" or "4:3") to indicate the proportional relationship between the image's width and height.
url
string
Required
The URL of the image, which provides the location where the image is hosted and can be accessed.
created_by
object (UserInfo)
Information about the user who created the collection.
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
description
string
A description of the collection.
is_active
boolean
Indicates whether the collection is currently active.
Default Value : true
is_visible
boolean
Indicates whether the collection is visible to users.
Default Value : true
logo
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
Required
The aspect ratio of the image, typically represented as a string (e.g., "16:9" or "4:3") to indicate the proportional relationship between the image's width and height.
url
string
Required
The URL of the image, which provides the location where the image is hosted and can be accessed.
meta
object
Additional metadata related to the collection.
Default Value : [object Object]
modified_by
object (UserInfo)
Information about the user who last modified the collection.
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
name
string
Required
The name of the collection.
priority
integer
The priority level of the collection, used to determine its display order.
Default Value : 99999
published
boolean
Indicates whether the collection is published and available to users.
Default Value : true
query
array of object (CollectionQuery)
Query objects that define how the collection's items are retrieved or filtered.
Default Value :
Array of CollectionQuery
attribute
string
Required
The attribute of the collection query
op
string
Required
The operation to be performed on the attribute of the collection query
Enum
value
array of object
Required
The value of the attribute of the collection query
seo
object (SeoDetail)
SeoDetail
description
string
SEO meta description for the item or collection. This is used to describe the content for search engines.
title
string
SEO meta title for the item or collection. It is used as the title that appears in search results.
sitemap
object
Information regarding the sitemap configuration for the item or collection.
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
List of breadcrumbs for navigation, showing the hierarchy of pages leading to the current page.
Array of ApplicationItemSeoBreadcrumbs
url
string
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
type
string
Required
meta_tags
array of object (Metatags)
An array of meta tags, each containing key-value pairs for various SEO meta tags used to enhance search visibility.
Array of Metatags
title
string
The title or heading for the meta tags section.
items
array of object (ApplicationItemSeoMetaTagItem)
An array of meta tag items, each consisting of key-value pairs.
Array of ApplicationItemSeoMetaTagItem
key
string
Required
value
string
Required
canonical_url
string
The canonical URL for the item or collection, which tells search engines the preferred version of the URL to avoid duplicate content issues.
slug
string
Required
The URL-friendly identifier for the collection.
sort_on
string
The default sorting order for items in the collection, e.g., 'popular'.
Default Value : popular
tags
array of string
Array of tags associated with the collection for categorization and filtering.
type
string
Required
The type of collection, either 'items' for manually added items or 'query' for dynamically fetched items.
Enum
visible_facets_keys
array of string
Keys of the facets that are visible and can be used for filtering the collection.
Default Value :
Response
200
List of all the collections including the one you added.
CollectionCreateResponseSchema
uid
string
Unique identifier for the collection.
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
The cron expression that defines the scheduling pattern, allowing for tasks or events to be repeated at specific intervals (e.g., daily, weekly).
duration
integer
Nullable
The duration in seconds for which the collection is active or valid.
end
string
| date-time
Nullable
The end date and time for the collection's schedule, formatted as a date-time string.
next_schedule
array of object (NextSchedule)
The next set of scheduled times when the collection will become active, based on the cron expression.
Array of NextSchedule
end
string
| date-time
Nullable
The end time of the schedule.
start
string
| date-time
The start time of the schedule.
start
string
| date-time
The start date and time for the collection's schedule, formatted as a date-time string.
allow_facets
boolean
Indicates whether facet-based filtering is allowed for the collection.
allow_sort
boolean
Indicates whether sorting options are allowed for the collection.
app_id
string
The application ID associated with the collection.
badge
object
Details of the badge associated with the collection.
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
cron
object
description
string
A description of the collection.
is_active
boolean
Indicates whether the collection is currently active.
logo
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
meta
object
Additional metadata related to the collection.
name
string
The name of the collection.
priority
integer
The priority level of the collection, used to determine its display order.
query
array of object (CollectionQuery)
Query objects that define how the collection's items are retrieved or filtered.
Array of CollectionQuery
attribute
string
The attribute of the collection query
op
string
The operation to be performed on the attribute of the collection query
Enum
value
array of object
The value of the attribute of the collection query
slug
string
The URL-friendly identifier for the collection.
sort_on
string
The default sorting order for items in the collection, e.g., 'popular'.
tag
array of string
Array of tags associated with the collection for categorization and filtering.
type
string
The type of collection, such as 'items' for manually added items or 'query' for dynamically fetched items.
visible_facets_keys
array of string
Keys of the facets that are visible and can be used for filtering the collection.
published
boolean
Indicates whether the collection is published.
tags
array of string
List of tags associated with the collection.
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
_custom_json
object
Custom JSON data for additional information.
_locale_language
object
Locale language settings for the collection.
seo
object (SeoDetail)
SeoDetail
description
string
SEO meta description for the item or collection. This is used to describe the content for search engines.
title
string
SEO meta title for the item or collection. It is used as the title that appears in search results.
sitemap
object
Information regarding the sitemap configuration for the item or collection.
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
List of breadcrumbs for navigation, showing the hierarchy of pages leading to the current page.
Array of ApplicationItemSeoBreadcrumbs
url
string
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (Metatags)
An array of meta tags, each containing key-value pairs for various SEO meta tags used to enhance search visibility.
Array of Metatags
title
string
The title or heading for the meta tags section.
items
array of object (ApplicationItemSeoMetaTagItem)
An array of meta tag items, each consisting of key-value pairs.
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
The canonical URL for the item or collection, which tells search engines the preferred version of the URL to avoid duplicate content issues.
is_visible
boolean
Indicates if the collection is visible to users.
id
string
Unique identifier for the collection.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
q:
"test"
schedule_status:
"live"
type:
"query"
tags:
"Test Collection 123"
is_active:
true
page_no:
1
page_size:
1
POST
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/
Loading...
Response
Loading...
DEL

Delete a collection

Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier of a collection.
Response
200
Status object. Tells whether the operation was successful.
CommonResponseSchemaCollection
message
string
A message providing details about the response.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
id:
"65620443a7d23306c5d75df2"
DEL
/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{id}/
Loading...
Response
Loading...
PUT

Update a collection

Update a collection by it's id. On successful request, returns the updated collection
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier of a collection.
Request body
_custom_json
object
Custom JSON object containing additional metadata specific to the collection.
_locale_language
object
Locale-based language settings for the collection.
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
The cron expression that defines the scheduling pattern, allowing for tasks or events to be repeated at specific intervals (e.g., daily, weekly).
duration
integer
Nullable
The duration in seconds for which the collection is active or valid.
end
string
| date-time
Nullable
The end date and time for the collection's schedule, formatted as a date-time string.
next_schedule
array of object (NextSchedule)
The next set of scheduled times when the collection will become active, based on the cron expression.
Array of NextSchedule
end
string
| date-time
Nullable
The end time of the schedule.
start
string
| date-time
The start time of the schedule.
start
string
| date-time
The start date and time for the collection's schedule, formatted as a date-time string.
allow_facets
boolean
Indicates whether facets are allowed for filtering items in the collection.
allow_sort
boolean
Specifies whether sorting is allowed for items within the collection.
badge
object (CollectionBadge)
CollectionBadge
color
string
The color of the badge displayed with the collection, typically represented as a string (e.g., a hex code or color name).
text
string
The text displayed on the badge, which may indicate a label or promotion related to the collection.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
banners
object (CollectionBanner)
CollectionBanner
landscape
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
Required
The aspect ratio of the image, typically represented as a string (e.g., "16:9" or "4:3") to indicate the proportional relationship between the image's width and height.
url
string