Retrieve a product

Retrieve a product

Authorizations:Token, JWT

Query Parameters

id required

integer>= 1

Responses

200Product resource

Response schema: application/jsonapplication/ld+json

Product resource

sku	string[1 .. 32] charactersExample: "0001"
name	string[1 .. 255] charactersExample: "Product name"
description	stringExample: "Full description"
brief_description	stringExample: "Description"
meta_tags	string
meta_description	string
meta_title	string
price	number or null
manualPrice	numberExample: 9.99
enabled	booleanDefault: trueExample: true
weight	numberExample: 1.5
separate_box	boolean
width	numberExample: 1.5
length	numberExample: 1.5
height	numberExample: 1.5
shippable	booleanDefault: trueExample: true
taxable	booleanDefault: trueExample: true
create_date	object or nullExample: "2024-07-20T00:00:00+00:00"
object null
update_date	object or nullExample: "2024-07-20T00:00:00+00:00"
object null
arrival_date	object or nullExample: "2024-07-20T00:00:00+00:00"
object null
inventory_traceable	booleanDefault: trueExample: true
amount	integer or null
availableAmount	integer or null
clean_url	string
memberships	Array of integers
tax_class	integer
product_class	integer
images	Array of objects or null
Array position integer alt string url string width integer height integer id integer>= 1
facebook_marketing_enabled	booleanDefault: trueExample: true
fitment_type	stringEnum: "regular""universal""specific"
fitments	Array of objects or null
Array level1 string level2 string level3 string level4 string notes string
costPrice	number
minPurchaseQuantity	integer or null
applySaleToWholesale	boolean or null
wholesalePrices	Array of objects or null
Array quantityRangeBegin integer quantityRangeEnd integer type stringEnum: "price""percent" value number
upc	string or null
mnf	string or null
stickers	Array of objects
Array label string textColor string bgColor string
market_price	number
tags	Array of objects
Array id integer name string
google_feed_enabled	booleanDefault: trueExample: true
participate_sale	boolean
discount_type	stringDefault: "sale_percent"Enum: "sale_price""sale_percent"Example: "sale_percent"
sale_price_value	number
variation_bases	Array of objects
Array name string isDefault boolean mainVariationPosition integer id integer>= 1
og_meta_tags	string
useCustomOG	boolean
id	integer or null>= 1

401Unauthorized

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Unauthorized

type	stringExample: "https://tools.ietf.org/html/rfc2616#section-10"
title	stringExample: "An error occurred"
detail	string or nullExample: "Cannot find entity"
instance	string or null

404Resource not found

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Resource not found

type	stringExample: "https://tools.ietf.org/html/rfc2616#section-10"
title	stringExample: "An error occurred"
detail	string or nullExample: "Cannot find entity"
instance	string or null

500Internal error

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Internal error

type	stringExample: "https://tools.ietf.org/html/rfc2616#section-10"
title	stringExample: "An error occurred"
detail	string or nullExample: "Cannot find entity"
instance	string or null