1min

Get Product by ID

GET
Retrieves a single product by ID. This request will include all offers of that product.
PATH PARAMETERS
product_idstring*
HEADER PARAMETERS
X-Violet-Tokenstring
X-Violet-App-Secretstring
X-Violet-App-Idinteger
RESPONSES
200
successful operation
Product
Products
idstring
namestring
Product Name
descriptionstring
Product Description
long_descriptionstring
Product Long Description
slugstring
Product Slug/Handle
brandstring
Brand
availableboolean
Is the Product Available
visibleboolean
Is the Product Visible
typestring<physical | digital | virtual>
Product Type
currencystring<USD | GBP>
min_priceinteger<int32>
Minimum Price of the Product
max_priceinteger<int32>
Maximum Price of the Product
variants
ProductVariant[]
Product Variants
offers
Offer[]
Merchant Offerings
categories
Category[]
Categories
genderstring<MALE | FEMALE | UNISEX>
Gender
meta
Meta[]
Meta Data
tagsstring[]
Tags
related_product_idsstring[]
ID's of related products.
cross_sale_product_idsstring[]
ID's of Cross Saleable Products.
gtinsstring[]
List of Global Trade Item Numbers
default_image_urlstring
The default/cover image of the Product
qty_availableinteger<int32>
Overall Quantity
max_commission_ratenumber<double>
The maximum commission rate offered by a merchant.
date_createdstring<date-time>
Date of product creation
date_last_modifiedstring<date-time>
Date of last product update
Updated 21 Apr 2022
Did this page help you?
Yes
No