Skip to main content

Retrieve product by id

Retrieve product by id

Authorizations:Token
Query Parameters
id
required
integerId value of the Product object

Responses

200Success
Response schema:
Success
featuredProductsArrayFeatured products (relation)
attachmentsArrayProduct attachments
useCustomOGbooleanUser Open graph meta tags generator flag
marketPricestringProduct market price
pinCodesEnabledbooleanWhether pin codes are enabled for this product
autoPinCodesbooleanWhether to create pin codes automatically
pinCodesArrayPin codes (relation)
views_statsArrayRelation to product views statistics
purchase_statsArrayRelation to product purchase statistics
participateSalebooleanFlag, if the product participates in the sale
discountTypestringself::SALE_DISCOUNT_TYPE_PRICE if "sale value" is considered as "Sale price", self::SALE_DISCOUNT_TYPE_PERCENT if "sale value" is considered as "Percent Off".
salePriceValuestring"Sale value"
xcPendingBulkEditbooleanFlag to exporting entities (no need setters and getters)
tabsArrayOrder tabs
isCustomerAttachmentsAvailablebooleanProduct is available for customer attachments
isCustomerAttachmentsRequiredbooleanAttachment is required for add to cart
facebookMarketingEnabledbooleanProduct is available for Facebook Marketing feed
freeShipbooleanIs product excluded from shipping calculation
shipForFreebooleanIs free shipping available for the product
freightFixedFeestringShipping freight fixed fee
googleFeedEnabledbooleanProduct is available for Google feed
useAsSegmentConditionbooleanUse product in segment conditions
vendor
demobooleanFlag, if the product participates in the sale
tagsArrayTags
reviewsArrayProduct reviews
upsellingProductsArrayLinks to related products (relation [this product] -> [related product])
upsellingParentProductsArrayBack links from related products (back relation [related product] -> [this product])
product_idintegerProduct unique ID
pricestringProduct price
skustringProduct SKU
enabledbooleanIs product available or not
weightstringProduct weight
useSeparateBoxbooleanIs product shipped in separate box
boxWidthstringProduct box width
boxLengthstringProduct box length
boxHeightstringProduct box height
itemsPerBoxintegerHow many product items can be placed in a box
free_shippingbooleanFlag: false - product is shippable, true - product is not shippable
taxablebooleanIf false then the product is free from any taxes
arrivalDateintegerArrival date (UNIX timestamp)
dateintegerCreation date (UNIX timestamp)
updateDateintegerUpdate date (UNIX timestamp)
needProcessbooleanIs product need process or not
categoryProductsArray of objects (Relation to a CategoryProducts entities)Relation to a CategoryProducts entities
Array
idinteger
orderbyinteger
orderbyInProductinteger
categoryobject
productobject
order_itemsArrayProduct order items
imagesArrayProduct images
inventoryEnabledbooleanIs inventory tracking enabled or not
amountintegerAmount
lowLimitEnabledCustomerbooleanIs low limit notification enabled for customer or not
lowLimitEnabledbooleanIs low limit notification enabled for admin or not
lowLimitAmountintegerLow limit amount
productClass
taxClassobject
idintegerID
positionintegerPosition
attributesArrayAttributes
attributeValueCArrayAttribute value (checkbox)
attributeValueTArrayAttribute value (text)
attributeValueSArrayAttribute value (select)
attributeValueHArrayAttribute value (hidden)
attrSepTabbooleanShow product attributes in a separate tab
quickDataArrayQuick data
membershipsArrayMemberships
cleanURLsArrayClean URLs
metaDescTypestringMeta description type
salesintegerSales
xcPendingExportbooleanFlag to exporting entities