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.
List sales channel brands
List sales channel brands
getApplicationBrandListing
Update sales channel brand
Update sales channel brand
updateAppBrand
List brands
List brands
getApplicationBrands
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.
List categories
List categories
getCategories
List sales channel categories
List sales channel categories
getApplicationCategoryListing
Update sales channel category
Update sales channel category
updateAppCategory
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.
List collections
List collections
getAllCollections
Create a collection
Create a collection
createCollection
Delete a collection
Delete a collection
deleteCollection
Update a collection
Update a collection
updateCollection
List items of collection
List items of collection
getCollectionItems
Create items in a collection
Create items in a collection
addCollectionItems
Get a collection
Get a collection
getCollectionDetail
Department
A department categorizes products into different sections or categories based on their type or purpose. Departments help organize products in a logical manner, making it easier for customers to navigate the product catalog. Each department typically has a unique identifier and a name. For example, a clothing ecommerce platform might have departments such as Men's Clothing, Women's Clothing, Accessories, Footwear, etc. You can retrieve a list of all departments associated with available products, facilitating easy navigation and organization of products based on departmental categorization. Additionally, the APIs allow you to list all products associated with a specific brand, collection, or category in a random order, enhancing user engagement and discovery within your application
List sales channel departments
List sales channel departments
getApplicationDepartmentListing
Update sales channel department
Update sales channel department
updateAppDepartment
List departments
List departments
getDepartments
Product
The "Product" resource offers detailed insights into items available for sale on Sales Channels or Marketplaces. It provides comprehensive product listings, stock status insights, seller details, and facilitates efficient product catalog management
List sales channel inventory
List sales channel inventory
getAppInventory
Get discounted inventory
Get discounted inventory
getDiscountedInventoryBySizeIdentifier
Get product details
Get product details
getProductDetailBySlug
Sales Channel
A sales channel, also known as application, enables the seller to list and sell their products. Different types of sales channels are available namely - 1. Storefront websites - create your own custom storefront website with a free or your own domain. 2. Marketplaces integrations - upload product catalog on platform and sync it to external marketplaces like Myntra, Amazaon, Fynd, etc. You can use this resource to retrieve details of the current sales channel. To identify an application, we use the id as the application identifier and the associated token in the header, and then return the corresponding application details.
Update sales channel location
Update sales channel location
updateAppLocation
Sales Channel Cataloging
Sales Channel Cataloging is the customization of product listings, query filters, and catalog configuration for a sales channel. Sales Channel Configuration can be used for effectively tailoring sales strategies, improving product visibility, and optimising customer interactions across various sales channels. Build catalog for a sales channel by selecting multiple brands and other properties like imageless, verified/unverified, out-of-stock. Additionally, allow products available in certain companies or selling locations.
Get collection query filters
Get collection query filters
getQueryFilters
Update default sorting
Update default sorting
updateDefaultSort
Get listing configurations
Get listing configurations
getListingConfigurations
Create listing configuration
Create listing configuration
createListingConfiguration
Get group configurations
Get group configurations
getGroupConfigurations
Create group configuration
Create group configuration
createGroupConfiguration
Delete group configuration
Delete group configuration
deleteGroupConfiguration
Update group configuration
Update group configuration
updateGroupConfiguration
Delete listing configuration
Delete listing configuration
deleteListingConfiguration
Update listing configuration
Update listing configuration
updateListingConfiguration
Get configuration metadata
Get configuration metadata
getConfigurationMetadata
Sales Channel Product
Sales channel product is used for management of all the product listed on the sales Channel. Sales channel products refer to all the products that are configured to be sold on your sales channels through your sales channel. With this resource, you can fetch and configure various aspects of Sales channel(application) product configurations, including: Minimum Quantity: Define the minimum quantity required for purchase of the product. Maximum Quantity: Set the maximum quantity that can be purchased for the product. Increment Unit: Specify the unit of increment for quantities, such as individual items or sets. SEO Configuration: Add search engine optimization (SEO) attributes to enhance product visibility and searchability. Cash on Delivery Option: Enable or disable the cash on delivery payment option for the product. Gift Option: Specify whether the product can be purchased as a gift, allowing users to select gift-related options during checkout.
Get sales channel product
Get sales channel product
getAppProduct
Update sales channel product
Update sales channel product
updateAppProduct
List sales channel products
List sales channel products
getAppicationProducts
List sales channel products
List sales channel products
getAppProducts
Selling Location
A selling location represents a geographical location where your stores, pop-up stores, headquarters, and warehouses exist. Find in-stock locations for products Additionally, the API retrieves detailed location information by ID, offering comprehensive store details for enhanced user convenience