Skip to main content

Retrieve a product by clean url

Retrieve a product by id

Authorizations:Token, JWT
Query Parameters
id
required
integer>= 1

Responses

200Product Detailed resource
Response schema:
Product Detailed resource
skustring
namestring
cleanUrlstring
briefDescriptionstring
pricenumber or null
weightnumber
requiresShippingboolean
arrivalDateinteger
amountinteger
imagesArray of objects
Array
urlstring
widthinteger
heightinteger
altstring
pathArray of objects
Array
idinteger
namestring
cleanUrlstring
descriptionstring
metaTagsstring
metaDescriptionstring
metaTitlestring
attributesArray of objects
Array
idinteger
namestring
typestringEnum: "T""C""S""H"
displayModestringEnum: "S""B""P""C"
editableboolean
displayAboveboolean
valuesArray of objects
Array
idinteger
valuestring
priceModifiernumber
priceModifierTypestring
weightModifiernumber
weightModifierTypestring
isDefaultboolean
swatchColorstring
swatchImageobject
urlstring
widthinteger
heightinteger
groupstring
dimensionsobject
lengthnumber
widthnumber
heightnumber
tabsArray of objects
Array
serviceNamestring
namestring
contentstring
briefInfostring
fitmentobject
typestringEnum: "regular""universal""specific"
fitmentsArray of objects
Array
namestring
levelsArray of objects
Array
namestring
idinteger
brandobject or null
  • object
  • null
namestring
cleanUrlstring
logoobject or null
  • object
  • null
urlstring
widthinteger or null
heightinteger or null
altstring or null
minPurchaseQuantityinteger
applySaleToWholesaleboolean
wholesalePricesArray of objects
Array
quantityRangeBegininteger
quantityRangeEndinteger
typestringEnum: "price""percent"
valuenumber
upcstring or null
mnfstring or null
stickersArray of objects
Array
labelstring
textColorstring
bgColorstring
attachmentsArray of objects
Array
titlestring
descriptionstring
urlstring
marketPricenumber or null
tagsArray of strings
participateSaleboolean
discountTypestringEnum: "sale_price""sale_percent"
saleValuenumber
salePricenumber
main_variation_base_idinteger or null
variation_basesArray of objects
Array
namestring
productsArray of objects
Array
product_idinteger
pricenumber
amountinteger
positioninteger
variation_attributesArray of objects
Array
attribute_idinteger
attribute_namestring
option_idinteger
option_namestring
idinteger>= 1
idinteger or null>= 1
401Unauthorized
Response schema:
Unauthorized
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null
404Resource not found
Response schema:
Resource not found
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null
500Internal error
Response schema:
Internal error
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null