Skip to main content

​
Get Product Listing

GET /api/v2/products/157/1
Retrieve a paginated list of products for a specific category.

​
Path Parameters

​
cat
integer
required
Category ID to filter products. Special handling for categories:
  • 374 returns products from categories 374 and 391
  • 157 returns products from categories 157 and 527
​
page
integer
required
Page number for pagination (starts at 1)

​
Query Parameters

​
sort
integer
default:"1"
Sort order for products:
  • 0: Sort alphabetically by product name
  • 1: Default sort order (by sort_order field)
  • 2: Sort by newest (target_date descending)
  • 3: Sort by price (low to high)
  • 4: Sort by price (high to low)
  • 5: Sort alphabetically by product name

​
Request Body (POST)

You can also POST to this endpoint with filter options:
​
sort
integer
default:"1"
Sort order (same values as query parameter)
​
tags
array
Array of tag slugs to filter products by theme/tag
​
cats
array
Array of category IDs for additional filtering

​
Response

​
totalPages
integer
Total number of pages available
​
products
array
Array of product objects

​
Pagination Details

  • Page Size: 18 products per page
  • Calculation: skips = page_size * (page_num - 1)
  • Products are sorted with in-stock items appearing first

​
Get Product Detail

POST /api/v2/product/harry-potter-gryffindor-t-shirt
Retrieve detailed information for a specific product.

​
Path Parameters

​
product_slug
string
required
URL-encoded product slug (URL key)

​
Query Parameters

​
platform
string
Platform identifier:
  • web: Web platform (action_source = 1)
  • Other values: Mobile/app (action_source = 2)
​
gender_type
string
Filter images by gender type:
  • 0: Unisex (shows all images)
  • 1: Male images
  • 2: Female images

​
Response

​
id
integer
Product ID
​
product
string
Product name
​
url_key
string
Product URL slug
​
price
number
Final price after GST and pricelist adjustments
​
spl_price
number
Special price (0 if no discount)
​
exclusive_price
number
Exclusive member price
​
show_exclusive_message
boolean
Whether to display exclusive pricing message
​
mrp
number
Maximum retail price
​
images
array
Array of product images filtered by gender_type if specified
​
variant
array
Product variants with stock and pricing information
​
options
array
Options for combo products (prod_type = 6)
​
prod_type
integer
Product type (1 = simple, 3 = configurable, 6 = combo, 8 = gift voucher)
​
prod_qty
integer
Available quantity for simple products
​
gst
number
GST percentage
​
rating_count
integer
Number of ratings
​
avg_rating
number
Average rating score
​
avg_product_rating
number
Calculated average product rating
​
is_printable
integer
Whether product is printable (1 = yes, 0 = no)
​
is_exchangeable
integer
Whether product is exchangeable
​
is_returnable
integer
Whether product is returnable
​
exchange_return_message
string
Message about exchange/return policy for this product
​
pageview_event_id
string
Facebook pageview event ID (web platform only)
​
viewcontent_event_id
string
Facebook view content event ID (web platform only)

​
Pricing Logic

  1. Prices include GST based on user session settings
  2. Exclusive pricing applies for exclusive members
  3. Pricelist adjustments are applied based on user session
  4. Tax slab GST may override product GST for specific price ranges

​
Variant Information

  • Configurable products (prod_type = 3) include variant arrays
  • Variants are filtered by size list configuration
  • Stock is capped at the variant stock threshold
  • Each variant includes price, stock, and attribute information

​
Error Responses

  • 404 Not Found: Product slug doesn’t exist or product is unavailable/deleted
  • 400 Bad Request: Invalid request (GET method not supported for detail endpoint)

Build docs developers (and LLMs) love

Get started for freeTalk to us