Wishlist
The Wishlist module manages the user's followed items, allowing users to follow or unfollow products, brands, and collections. Use it to retrieve a list of followed items, get follower counts for specific items, and fetch the IDs of items the user is currently following.
Customers have the ability to follow or unfollow specific products based on their preferences, allowing them to curate a list of favorites. This feature enables users to manage their preferences and interactions with different content or entities. By retrieving a list of products or brands they are following, customers can easily keep track of their interests. They can remove items, brands, or products from their followed list using the collection ID, and add new ones using the same ID. Additionally, customers can find out how many other users are following a specific item and get the IDs of all the items they are currently following, whether they are products, brands, or collections.
Operations
GET
# Retrieves user's followed listings.
POST
# Add products to wishlist (bulk support).
DEL
# Delete item, brand, product
GET
# Retrieves follower count for an item.
GET
# Fetches IDs of followed items.
FDK Method Name: getFollowedListing
Get a list of products or brands the user is following.
Parameters
collection_type
string
Required
Type of collection followed, i.e. products, brands, or collections.
Enum
page_id
string
Page ID to retrieve next set of results.
Default Value : 1
page_size
integer
Page ID to retrieve next set of results.
Default Value : 12
Response
200
Success. Returns a Followed resource object.
GetFollowListingResponseSchema
items
array of object (ProductListingDetail)
An array of product details that the user is following. Each item includes information such as the product name, price, and other attributes.
Array of ProductListingDetail
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
uid
integer
Unique identifier for the product.
custom_order
object (ProductDetailCustomOrder)
ProductDetailCustomOrder
manufacturing_time
integer
The unit of time taken for manufacturing.
manufacturing_time_unit
string
The unit of time required for manufacturing is defined in hours or days.
is_custom_order
boolean
A boolean flag indicating whether MTO (Make to Order) is enabled or not.
sizes
array of string
Available sizes for the product.
category_map
object (ProductCategoryMap)
ProductCategoryMap
l1
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
custom_url
string
Custom URL for brand.
name
string
Name of the product brand.
type
string
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
l2
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
custom_url
string
Custom URL for brand.
name
string
Name of the product brand.
type
string
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
l3
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
custom_url
string
Custom URL for brand.
name
string
Name of the product brand.
type
string
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
net_quantity
object (NetQuantity)
NetQuantity
unit
string
The unit of measurement used for the net quantity of the product.
Enum
value
number
| value >= 0.001
The value of the net quantity of the product.
rating_count
integer
The number of ratings the product has received.
_custom_meta
array of object (CustomMetaFields)
Custom metadata fields associated with the product.
Array of CustomMetaFields
value
string
A value to store in the custom field.
Minimum Length : 1
Maximum Length : 100
key
string
A key to store a custom field.
Minimum Length : 1
Maximum Length : 30
similars
array of string
List of products marked similar to given product.
tags
array of string
Tags associated with the product for better categorization.
seo
object (ApplicationItemSEO)
ApplicationItemSEO
description
string
The SEO description of the item.
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
| float
The SEO priority of the item.
Enum
frequency
string
The SEO frequency of the item.
Enum
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
Details of the page associated with this SEO action.
type
string
Type of action, such as navigation or redirection.
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
The SEO title of the product.
items
array of object (ApplicationItemSeoMetaTagItem)
The SEO items for the product.
Array of ApplicationItemSeoMetaTagItem
key
string
The name of the meta tag.
value
string
The value associated with the meta tag.
canonical_url
string
The SEO canonical URL of the item.
image_nature
string
Type of the images associated with the product such as standard.
has_variant
boolean
Indicates whether the product has variants.
item_type
string
This field describes the type of item, indicating the category or nature of the product. Possible values are Standard, Composite, Set Digital.
Enum
description
string
Detailed description of the product.
grouped_attributes
array of object (ProductDetailGroupedAttribute)
Grouped attributes detailing various characteristics of the product.
Array of ProductDetailGroupedAttribute
title
string
The title or name of the attribute group.
details
array of object (ProductDetailAttribute)
A list of product attributes within this group.
Array of ProductDetailAttribute
value
string
The value of the product attribute.
type
string
The type or category of the product attribute.
key
string
The key or name of the product attribute.
medias
array of object (Media)
Media files associated with the product.
Array of Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
color
string
Color of the product, if applicable.
type
string
Product type or classification.
product_online_date
string
| date-time
Date and time when the product was made available online.
_custom_json
object
Custom JSON object for additional product data.
item_code
string
Item Code defined for the product.
name
string
Name of the product.
moq
object (ApplicationItemMOQ)
ApplicationItemMOQ
minimum
integer
| value >= 1
The minimum quantity required for purchase.
Default Value : 1
maximum
integer
The maximum quantity allowed for purchase.
increment_unit
integer
| value >= 1
The minimum quantity increment in which the item can be purchased.
Default Value : 1
short_description
string
Brief description of the product.
categories
array of object (ProductBrand)
List of product categories associated with the product.
Array of ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
custom_url
string
Custom URL for brand.
name
string
Name of the product brand.
type
string
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
sellable
boolean
Indicates whether the product is available for sale.
attributes
object
Additional attributes or characteristics of the product.
variants
array of object (ProductVariantListingResponseSchema)
List of product variants available for the product.
Array of ProductVariantListingResponseSchema
header
string
Header or title for the product variant section.
items
array of object (ProductVariantItemResponseSchema)
List of Upto 5 product variant items.
Array of ProductVariantItemResponseSchema
uid
integer
Unique identifier for the product variant.
color_name
string
Name of the color for the variant.
color
string
Color code or representation for the variant.
medias
array of object (Media)
Media files associated with the product variant.
Array of Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
is_available
boolean
Indicates whether the product variant is available for purchase.
_custom_meta
array of object (CustomMetaFields)
Custom metadata fields associated with the product.
Array of CustomMetaFields
value
string
A value to store in the custom field.
Minimum Length : 1
Maximum Length : 100
key
string
A key to store a custom field.
Minimum Length : 1
Maximum Length : 30
name
string
Name of the product variant.
value
string
Value or label representing the product variant.
slug
string
URL-friendly identifier for the product.
_custom_json
object
Custom JSON object for additional data related to the product.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
total
integer
The total number of product variants available.
key
string
Attribute identifier of the variant.
display_type
string
The type of display for the product variant (e.g., image, text, image, color).
discount
string
Discount details or percentage applied to the product.
tryouts
array of string
List of tryout options available for the product.
identifiers
array of string
List of seller identifiers for the product.
Default Value :
slug
string
URL-friendly identifier for the product.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
rating
number
Rating of the product.
is_dependent
boolean
Indicates whether the product can be sold as an individual product.
product_group_tag
array of string
List of bundle/product grouping slugs mapped to the product.
highlights
array of string
Key highlights or features of the product.
price
object (ProductListingPrice)
ProductListingPrice
effective
object (Price)
Price
min
number
The minimum price for the product across stores.
currency_symbol
string
The currency symbol for the currency in which the product is available.
currency_code
string
The currency code for the currency in which the product is available.
max
number
The maximum price for the product across stores.
marked
object (Price)
Price
min
number
The minimum price for the product across stores.
currency_symbol
string
The currency symbol for the currency in which the product is available.
currency_code
string
The currency code for the currency in which the product is available.
max
number
The maximum price for the product across stores.
selling
object (Price)
Price
min
number
The minimum price for the product across stores.
currency_symbol
string
The currency symbol for the currency in which the product is available.
currency_code
string
The currency code for the currency in which the product is available.
max
number
The maximum price for the product across stores.
brand
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
custom_url
string
Custom URL for brand.
name
string
Name of the product brand.
type
string
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
teaser_tag
string
Teaser tag or short promotional phrase for the product.
country_of_origin
string
The country of origin for the product.
is_tryout
boolean
Indicates if the product is available for tryout.
channel
string
Identifier for the product channel.
modified_on
string
| date-time
Date and time when the filter was 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.
next
string
Nullable
Cursor token for the next page (alias for next_id used by search services).
item_count
integer
| int32
The number of items returned on the current 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.
limit
integer
| int32
The maximum number of items to be returned per page.
total
integer
| int32
Total number of items.
Examples
Parameters
collection_type:
"products"
page_id:
"636a4c5c295d937d233826a5"
page_size:
12
Was this section helpful?
GET
Response
Retrieves user's followed listings.
getFollowedListing
FDK Method Name: followById
Add one or more products to the user's wishlist. Only the `products` collection type is supported. When the wishlist is full, the oldest entries are evicted (FIFO) to make room. Maximum 50 product IDs per request.
Parameters
collection_type
string
Required
Type of collection. Only `products` is supported.
Enum
Request body
items
array of object (FollowBulkRequestItem)
Required
A list of bulk follow request items, each containing product IDs to add to the user's wishlist. Maximum 50 product IDs per request.
Array of FollowBulkRequestItem
products
array of integer
Required
An array of product IDs to add to the user's wishlist in bulk.
Response
200
400
Success. Returns the result of the bulk follow operation.
BulkFollowPostResponseSchema
success
boolean
Indicates whether the bulk follow operation was processed successfully.
added
array of integer
List of product IDs that were successfully added to the user's wishlist during this request.
already_present
array of integer
List of product IDs that were already in the user's wishlist and were not added again.
failed
array of integer
List of product IDs that could not be added to the wishlist due to an error.
Examples
Parameters
collection_type:
"products"
body:
body
Was this section helpful?
POST
Response
Add products to wishlist (bulk support).
followById
FDK Method Name: unfollowById
Remove a followed item, brand, or product using its collection ID.
Parameters
collection_type
string
Required
Type of collection followed, i.e. products, brands, or collections.
Enum
collection_id
string
Required
The ID of the collection type.
Response
200
400
Success. Returns a response object.
FollowPostResponseSchema
message
string
A message indicating the result of the follow or unfollow operation. This could be a confirmation message or an error message.
id
string
A unique identifier for the follow operation, which can be used to reference or track the follow status.
Examples
Parameters
collection_type:
"value"
collection_id:
"value"
Was this section helpful?
DEL
Response
Delete item, brand, product
unfollowById
FDK Method Name: getFollowerCountById
Get the total number of followers for a specific item by its ID.
Parameters
collection_type
string
Required
Type of collection, i.e. products, brands, or collections.
Enum
collection_id
integer
Required
The ID of the collection type.
Response
200
400
Success. Returns the number of followers for a given collection type.
FollowerCountResponseSchema
count
integer
The number of followers for the item. This count indicates how many users are following the specified item.
Examples
Parameters
collection_type:
"value"
collection_id:
1
Was this section helpful?
GET
Response
Retrieves follower count for an item.
getFollowerCountById
FDK Method Name: getFollowIds
Get the IDs of all items the user is currently following, such as Products, Brands, and Collections.
Parameters
No Parameters
Response
200
Success. Returns the IDs of all the Products, Brands and Collections which were followed.
FollowIdsResponseSchema
data
object (FollowIdsData)
FollowIdsData
products
array of integer
An array of IDs representing the products that the user is following.
collections
array of integer
An array of IDs representing the collections that the user is following.
brands
array of integer
An array of IDs representing the brands that the user is following.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response