Skip to main content

Retrieve a product by clean url

Retrieve a product by clean url.

Authorizations:Token, JWT
Query Parameters
clean_url
required
stringResource identifier

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""C"
editableboolean
displayAboveboolean
valuesArray of objects
Array
idinteger
valuestring
priceModifiernumber
priceModifierTypestring
weightModifiernumber
weightModifierTypestring
isDefaultboolean
swatchColorstring
swatchImageobject
urlstring
widthinteger
heightinteger
groupstring
dimensionsobject
lengthnumber
widthnumber
heightnumber
fitmentobject
typestringEnum: "regular""universal""specific"
fitmentsArray of objects
Array
namestring
levelsArray of objects
Array
namestring
idinteger
stickersArray of objects
Array
labelstring
textColorstring
bgColorstring
canBeBackorderedboolean
backorderQtyLabelstring
isLimitedBackorderboolean
backorderLimitinteger
attachmentsArray of objects
Array
titlestring
descriptionstring
urlstring
participateSaleboolean
discountTypestringEnum: "sale_price""sale_percent"
saleValuenumber
salePricenumber
marketPricenumber
minPurchaseQuantityinteger
applySaleToWholesaleboolean
wholesalePricesArray of objects
Array
quantityRangeBegininteger
quantityRangeEndinteger
typestringEnum: "price""percent"
valuenumber
tagsArray of strings
tabsArray of objects
Array
serviceNamestring
namestring
contentstring
briefInfostring
upcstring or null
mnfstring or null
brandobject or null
  • object
namestring
cleanUrlstring
logoobject or null
  • object
urlstring
widthinteger or null
heightinteger or null
altstring or null
idinteger or null>= 0
401Unauthorized
Response schema:
Unauthorized
typestring
titlestring
detailstring or null
instancestring or null
404Resource not found
Response schema:
Resource not found
typestring
titlestring
detailstring or null
instancestring or null
500Internal error
Response schema:
Internal error
typestring
titlestring
detailstring or null
instancestring or null