Get Product by ID
2min
GET
AUTHENTICATION
Authorization
string
Bearer
PATH PARAMETERS
product_id
string
*QUERY PARAMETERS
extended
boolean
include_disabled
boolean
base_currency
string
sort_skus
boolean
validate
boolean
HEADER PARAMETERS
X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer
RESPONSES
200
successful operation
Product
Products
id
string
name
string
*Product Name
description
string
Product Description
long_description
string
Product Long Description
slug
string
*Product Slug/Handle
brand
string
Brand
available
boolean
Is the Product Available
visible
boolean
Is the Product Visible
total_sales
integer<int32>
Number of times this product has been sold
type
string<physical | digital | virtual>
Product Type
currency
string<USD | GBP>
min_price
integer<int32>
Minimum Price of the Product
max_price
integer<int32>
Maximum Price of the Product
variants
ProductVariant[]
Product Variants
offers
Offer[]
Merchant Offerings
categories
Category[]
Categories
gender
string<MALE | FEMALE | UNISEX>
Gender
meta
Meta[]
Meta Data
tags
string[]
Tags
related_product_ids
string[]
ID's of related products.
cross_sale_product_ids
string[]
ID's of Cross Saleable Products.
gtins
string[]
List of Global Trade Item Numbers
default_image_url
string
The default/cover image of the Product
qty_available
integer<int32>
Overall Quantity
merchant_ids
integer[]
List of merchants selling this product.
date_created
string<date-time>
Date of product creation
date_last_modified
string<date-time>
Date of last product update
channelReady
boolean
requires
string[]
offersAvailable
integer<int32>
Updated 16 May 2023
Did this page help you?
Yes
No