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 featuredProducts | ArrayFeatured products (relation) | ||||||||||||
attachments | ArrayProduct attachments | ||||||||||||
ogMeta | stringCustom Open graph meta tags | ||||||||||||
useCustomOG | booleanUser Open graph meta tags generator flag | ||||||||||||
marketPrice | stringProduct market price | ||||||||||||
pinCodesEnabled | booleanWhether pin codes are enabled for this product | ||||||||||||
autoPinCodes | booleanWhether to create pin codes automatically | ||||||||||||
pinCodes | ArrayPin codes (relation) | ||||||||||||
views_stats | ArrayRelation to product views statistics | ||||||||||||
purchase_stats | ArrayRelation to product purchase statistics | ||||||||||||
participateSale | booleanFlag, if the product participates in the sale | ||||||||||||
discountType | stringself::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". | ||||||||||||
salePriceValue | string"Sale value" | ||||||||||||
xcPendingBulkEdit | booleanFlag to exporting entities (no need setters and getters) | ||||||||||||
tabs | ArrayOrder tabs | ||||||||||||
isCustomerAttachmentsAvailable | booleanProduct is available for customer attachments | ||||||||||||
isCustomerAttachmentsRequired | booleanAttachment is required for add to cart | ||||||||||||
facebookMarketingEnabled | booleanProduct is available for Facebook Marketing feed | ||||||||||||
freeShip | booleanIs free shipping available for the product | ||||||||||||
freightFixedFee | stringShipping freight fixed fee | ||||||||||||
useAsSegmentCondition | booleanUse product in segment conditions | ||||||||||||
exported_pb | booleanTrue if product was exported to PB and didn't change after | ||||||||||||
gpc | stringGlobal Product Code | ||||||||||||
gtin | stringGlobal Trade Identification Number | ||||||||||||
hs_code | stringHarmony system code | ||||||||||||
mpn | stringManufacturer part number | ||||||||||||
model_number | stringManufacturer model number | ||||||||||||
stock_number | stringManufacturer stock number | ||||||||||||
hazmat | booleanDoes contain hazardous materials? | ||||||||||||
chemicals | booleanDoes contain chemicals? | ||||||||||||
pesticide | booleanDoes contain pesticide? | ||||||||||||
aerosol | booleanDoes contain aerosol? | ||||||||||||
rppc | booleanDoes contain plastic container? | ||||||||||||
non_spillable | booleanDoes contain non spillable battery? | ||||||||||||
fuel | booleanCan contain fuel? | ||||||||||||
ormd | booleanDoes contain orm-d? | ||||||||||||
battery | stringBattery type | ||||||||||||
product_condition | stringCondition | ||||||||||||
country_of_origin | |||||||||||||
restrictions | Arrayrestrictions | ||||||||||||
tags | ArrayTags | ||||||||||||
variants | ArrayProduct variants | ||||||||||||
variantsAttributes | ArrayProduct variants attributes | ||||||||||||
wholesalePrices | ArrayRelation to a product entity | ||||||||||||
reviews | ArrayProduct reviews | ||||||||||||
upsellingProducts | ArrayLinks to related products (relation [this product] -> [related product]) | ||||||||||||
upsellingParentProducts | ArrayBack links from related products (back relation [related product] -> [this product]) | ||||||||||||
product_id | integerProduct unique ID | ||||||||||||
version | integer | ||||||||||||
price | stringProduct price | ||||||||||||
sku | stringProduct SKU | ||||||||||||
enabled | booleanIs product available or not | ||||||||||||
weight | stringProduct weight | ||||||||||||
useSeparateBox | booleanIs product shipped in separate box | ||||||||||||
boxWidth | stringProduct box width | ||||||||||||
boxLength | stringProduct box length | ||||||||||||
boxHeight | stringProduct box height | ||||||||||||
itemsPerBox | integerHow many product items can be placed in a box | ||||||||||||
free_shipping | booleanFlag: false - product is shippable, true - product is not shippable | ||||||||||||
taxable | booleanIf false then the product is free from any taxes | ||||||||||||
javascript | stringCustom javascript code | ||||||||||||
arrivalDate | integerArrival date (UNIX timestamp) | ||||||||||||
date | integerCreation date (UNIX timestamp) | ||||||||||||
updateDate | integerUpdate date (UNIX timestamp) | ||||||||||||
needProcess | booleanIs product need process or not | ||||||||||||
categoryProducts | Array of objects (Relation to a CategoryProducts entities)Relation to a CategoryProducts entities | ||||||||||||
Array
| |||||||||||||
order_items | ArrayProduct order items | ||||||||||||
images | ArrayProduct images | ||||||||||||
inventoryEnabled | booleanIs inventory tracking enabled or not | ||||||||||||
amount | integerAmount | ||||||||||||
lowLimitEnabledCustomer | booleanIs low limit notification enabled for customer or not | ||||||||||||
lowLimitEnabled | booleanIs low limit notification enabled for admin or not | ||||||||||||
lowLimitAmount | integerLow limit amount | ||||||||||||
productClass | |||||||||||||
taxClass | object | ||||||||||||
| |||||||||||||
attributes | ArrayAttributes | ||||||||||||
attributeValueC | ArrayAttribute value (checkbox) | ||||||||||||
attributeValueT | ArrayAttribute value (text) | ||||||||||||
attributeValueS | ArrayAttribute value (select) | ||||||||||||
attrSepTab | booleanShow product attributes in a separate tab | ||||||||||||
quickData | ArrayQuick data | ||||||||||||
memberships | ArrayMemberships | ||||||||||||
cleanURLs | ArrayClean URLs | ||||||||||||
metaDescType | stringMeta description type | ||||||||||||
sales | integerSales | ||||||||||||
xcPendingExport | booleanFlag to exporting entities |