Product is the building block of your store. It contains data about certain good you trade and is identified by SKU. Product is tightly coupled with its Category and Attributes.

GET
Retrieve product by conditions

_cnd[sKU]
string 
Filters products by sku
_cnd[enabled]
boolean 
Filters products by enabled\disabled state
_cnd[categoryId]
integer 
Filters products by category id
_cnd[price]
array 
Filters by min price (first item) and max price (second item)
_cnd[inventory]
string 
Filters products by stock status (inventory)
_cnd[excludingProductId]
array 
Excludes products with given IDs
_cnd[arrivalDate]
array 
Filters products by arrival date (timestamp) arranged in two-value array [start, end]
_cnd[arrivalDateRange]
string 
Filters products by arrival date in format of d-M-Y ~ d-M-Y
_cnd[limit]
array 
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array 
Sets sorting order field
default Success <XLite\Model\Product>[] array
Sample response
[{"featuredProducts":"<XLite\\Module\\CDev\\FeaturedProducts\\Model\\FeaturedProduct>[] array","attachments":"<XLite\\Module\\CDev\\FileAttachments\\Model\\Product\\Attachment>[] array","ogMeta":"string","useCustomOG":"boolean","marketPrice":"string","pinCodesEnabled":"boolean","autoPinCodes":"boolean","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","views_stats":"<XLite\\Module\\CDev\\ProductAdvisor\\Model\\ProductStats>[] array","purchase_stats":"<XLite\\Module\\CDev\\ProductAdvisor\\Model\\ProductStats>[] array","participateSale":"boolean","discountType":"string","salePriceValue":"string","xcPendingBulkEdit":"boolean","tabs":"<XLite\\Module\\XC\\CustomProductTabs\\Model\\Product\\Tab>[] array","isCustomerAttachmentsAvailable":"boolean","isCustomerAttachmentsRequired":"boolean","facebookMarketingEnabled":"boolean","freeShip":"boolean","freightFixedFee":"string","useAsSegmentCondition":"boolean","exported_pb":"boolean","gpc":"string","gtin":"string","hs_code":"string","mpn":"string","model_number":"string","stock_number":"string","hazmat":"boolean","chemicals":"boolean","pesticide":"boolean","aerosol":"boolean","rppc":"boolean","non_spillable":"boolean","fuel":"boolean","ormd":"boolean","battery":"string","product_condition":"string","country_of_origin":"<XLite\\Model\\Country>","restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","tags":"<XLite\\Module\\XC\\ProductTags\\Model\\Tag>[] array","variants":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>[] array","variantsAttributes":"<XLite\\Model\\Attribute>[] array","wholesalePrices":"<XLite\\Module\\CDev\\Wholesale\\Model\\WholesalePrice>[] array","reviews":"<XLite\\Module\\XC\\Reviews\\Model\\Review>[] array","upsellingProducts":"<XLite\\Module\\XC\\Upselling\\Model\\UpsellingProduct>[] array","upsellingParentProducts":"<XLite\\Module\\XC\\Upselling\\Model\\UpsellingProduct>[] array","product_id":"integer","price":"string","sku":"string","enabled":"boolean","weight":"string","useSeparateBox":"boolean","boxWidth":"string","boxLength":"string","boxHeight":"string","itemsPerBox":"integer","free_shipping":"boolean","taxable":"boolean","javascript":"string","arrivalDate":"integer","date":"integer","updateDate":"integer","needProcess":"boolean","categoryProducts":"<XLite\\Model\\CategoryProducts>[] array","order_items":"<XLite\\Model\\OrderItem>[] array","images":"<XLite\\Model\\Image\\Product\\Image>[] array","inventoryEnabled":"boolean","amount":"integer","lowLimitEnabledCustomer":"boolean","lowLimitEnabled":"boolean","lowLimitAmount":"integer","productClass":"<XLite\\Model\\ProductClass>","taxClass":"<XLite\\Model\\TaxClass>","attributes":"<XLite\\Model\\Attribute>[] array","attributeValueC":"<XLite\\Model\\AttributeValue\\AttributeValueCheckbox>[] array","attributeValueT":"<XLite\\Model\\AttributeValue\\AttributeValueText>[] array","attributeValueS":"<XLite\\Model\\AttributeValue\\AttributeValueSelect>[] array","attrSepTab":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","memberships":"<XLite\\Model\\Membership>[] array","cleanURLs":"<XLite\\Model\\CleanURL>[] array","metaDescType":"string","sales":"integer","xcPendingExport":"boolean"}]

GET
Retrieve product by id

id
integer Required
Id value of the Product object
default Success <XLite\Model\Product>
Sample response
{"featuredProducts":"<XLite\\Module\\CDev\\FeaturedProducts\\Model\\FeaturedProduct>[] array","attachments":"<XLite\\Module\\CDev\\FileAttachments\\Model\\Product\\Attachment>[] array","ogMeta":"string","useCustomOG":"boolean","marketPrice":"string","pinCodesEnabled":"boolean","autoPinCodes":"boolean","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","views_stats":"<XLite\\Module\\CDev\\ProductAdvisor\\Model\\ProductStats>[] array","purchase_stats":"<XLite\\Module\\CDev\\ProductAdvisor\\Model\\ProductStats>[] array","participateSale":"boolean","discountType":"string","salePriceValue":"string","xcPendingBulkEdit":"boolean","tabs":"<XLite\\Module\\XC\\CustomProductTabs\\Model\\Product\\Tab>[] array","isCustomerAttachmentsAvailable":"boolean","isCustomerAttachmentsRequired":"boolean","facebookMarketingEnabled":"boolean","freeShip":"boolean","freightFixedFee":"string","useAsSegmentCondition":"boolean","exported_pb":"boolean","gpc":"string","gtin":"string","hs_code":"string","mpn":"string","model_number":"string","stock_number":"string","hazmat":"boolean","chemicals":"boolean","pesticide":"boolean","aerosol":"boolean","rppc":"boolean","non_spillable":"boolean","fuel":"boolean","ormd":"boolean","battery":"string","product_condition":"string","country_of_origin":"<XLite\\Model\\Country>","restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","tags":"<XLite\\Module\\XC\\ProductTags\\Model\\Tag>[] array","variants":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>[] array","variantsAttributes":"<XLite\\Model\\Attribute>[] array","wholesalePrices":"<XLite\\Module\\CDev\\Wholesale\\Model\\WholesalePrice>[] array","reviews":"<XLite\\Module\\XC\\Reviews\\Model\\Review>[] array","upsellingProducts":"<XLite\\Module\\XC\\Upselling\\Model\\UpsellingProduct>[] array","upsellingParentProducts":"<XLite\\Module\\XC\\Upselling\\Model\\UpsellingProduct>[] array","product_id":"integer","price":"string","sku":"string","enabled":"boolean","weight":"string","useSeparateBox":"boolean","boxWidth":"string","boxLength":"string","boxHeight":"string","itemsPerBox":"integer","free_shipping":"boolean","taxable":"boolean","javascript":"string","arrivalDate":"integer","date":"integer","updateDate":"integer","needProcess":"boolean","categoryProducts":"<XLite\\Model\\CategoryProducts>[] array","order_items":"<XLite\\Model\\OrderItem>[] array","images":"<XLite\\Model\\Image\\Product\\Image>[] array","inventoryEnabled":"boolean","amount":"integer","lowLimitEnabledCustomer":"boolean","lowLimitEnabled":"boolean","lowLimitAmount":"integer","productClass":"<XLite\\Model\\ProductClass>","taxClass":"<XLite\\Model\\TaxClass>","attributes":"<XLite\\Model\\Attribute>[] array","attributeValueC":"<XLite\\Model\\AttributeValue\\AttributeValueCheckbox>[] array","attributeValueT":"<XLite\\Model\\AttributeValue\\AttributeValueText>[] array","attributeValueS":"<XLite\\Model\\AttributeValue\\AttributeValueSelect>[] array","attrSepTab":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","memberships":"<XLite\\Model\\Membership>[] array","cleanURLs":"<XLite\\Model\\CleanURL>[] array","metaDescType":"string","sales":"integer","xcPendingExport":"boolean"}
featuredProducts
[] array
Featured products (relation)
attachments
[] array
Product attachments
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
marketPrice
string
Product market price
pinCodesEnabled
boolean
Whether pin codes are enabled for this product
autoPinCodes
boolean
Whether to create pin codes automatically
pinCodes
[] array
Pin codes (relation)
views_stats
[] array
Relation to product views statistics
purchase_stats
[] array
Relation to product purchase statistics
participateSale
boolean
Flag, if the product participates in the sale
discountType
string
self::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
boolean
Flag to exporting entities (no need setters and getters)
tabs
[] array
Order tabs
isCustomerAttachmentsAvailable
boolean
Product is available for customer attachments
isCustomerAttachmentsRequired
boolean
Attachment is required for add to cart
facebookMarketingEnabled
boolean
Product is available for Facebook Marketing feed
freeShip
boolean
Is free shipping available for the product
freightFixedFee
string
Shipping freight fixed fee
useAsSegmentCondition
boolean
Use product in segment conditions
exported_pb
boolean
True if product was exported to PB and didn't change after
gpc
string
Global Product Code
gtin
string
Global Trade Identification Number
hs_code
string
Harmony system code
mpn
string
Manufacturer part number
model_number
string
Manufacturer model number
stock_number
string
Manufacturer stock number
hazmat
boolean
Does contain hazardous materials?
chemicals
boolean
Does contain chemicals?
pesticide
boolean
Does contain pesticide?
aerosol
boolean
Does contain aerosol?
rppc
boolean
Does contain plastic container?
non_spillable
boolean
Does contain non spillable battery?
fuel
boolean
Can contain fuel?
ormd
boolean
Does contain orm-d?
battery
string
Battery type
product_condition
string
Condition
country_of_origin
restrictions
[] array
restrictions
tags
[] array
Tags
variants
[] array
Product variants
variantsAttributes
[] array
Product variants attributes
wholesalePrices
[] array
Relation to a product entity
reviews
[] array
Product reviews
upsellingProducts
[] array
Links to related products (relation [this product] -> [related product])
upsellingParentProducts
[] array
Back links from related products (back relation [related product] -> [this product])
product_id
integer
Product unique ID
version
integer
price
string
Product price
sku
string
Product SKU
enabled
boolean
Is product available or not
weight
string
Product weight
useSeparateBox
boolean
Is product shipped in separate box
boxWidth
string
Product box width
boxLength
string
Product box length
boxHeight
string
Product box height
itemsPerBox
integer
How many product items can be placed in a box
free_shipping
boolean
Flag: false - product is shippable, true - product is not shippable
taxable
boolean
If false then the product is free from any taxes
javascript
string
Custom javascript code
arrivalDate
integer
Arrival date (UNIX timestamp)
date
integer
Creation date (UNIX timestamp)
updateDate
integer
Update date (UNIX timestamp)
needProcess
boolean
Is product need process or not
categoryProducts
[] array
Relation to a CategoryProducts entities
order_items
[] array
Product order items
images
[] array
Product images
inventoryEnabled
boolean
Is inventory tracking enabled or not
amount
integer
Amount
lowLimitEnabledCustomer
boolean
Is low limit notification enabled for customer or not
lowLimitEnabled
boolean
Is low limit notification enabled for admin or not
lowLimitAmount
integer
Low limit amount
productClass
taxClass
attributes
[] array
Attributes
attributeValueC
[] array
Attribute value (checkbox)
attributeValueT
[] array
Attribute value (text)
attributeValueS
[] array
Attribute value (select)
attrSepTab
boolean
Show product attributes in a separate tab
quickData
[] array
Quick data
memberships
[] array
Memberships
cleanURLs
[] array
Clean URLs
metaDescType
string
Meta description type
sales
integer
Sales
xcPendingExport
boolean
Flag to exporting entities

PUT
Update product by id

id
integer Required
Id value of the Product object
<XLite\Model\Product>
featuredProducts
[] array
Featured products (relation)
attachments
[] array
Product attachments
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
marketPrice
string
Product market price
pinCodesEnabled
boolean
Whether pin codes are enabled for this product
autoPinCodes
boolean
Whether to create pin codes automatically
pinCodes
[] array
Pin codes (relation)
views_stats
[] array
Relation to product views statistics
purchase_stats
[] array
Relation to product purchase statistics
participateSale
boolean
Flag, if the product participates in the sale
discountType
string
self::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
boolean
Flag to exporting entities (no need setters and getters)
tabs
[] array
Order tabs
isCustomerAttachmentsAvailable
boolean
Product is available for customer attachments
isCustomerAttachmentsRequired
boolean
Attachment is required for add to cart
facebookMarketingEnabled
boolean
Product is available for Facebook Marketing feed
freeShip
boolean
Is free shipping available for the product
freightFixedFee
string
Shipping freight fixed fee
useAsSegmentCondition
boolean
Use product in segment conditions
exported_pb
boolean
True if product was exported to PB and didn't change after
gpc
string
Global Product Code
gtin
string
Global Trade Identification Number
hs_code
string
Harmony system code
mpn
string
Manufacturer part number
model_number
string
Manufacturer model number
stock_number
string
Manufacturer stock number
hazmat
boolean
Does contain hazardous materials?
chemicals
boolean
Does contain chemicals?
pesticide
boolean
Does contain pesticide?
aerosol
boolean
Does contain aerosol?
rppc
boolean
Does contain plastic container?
non_spillable
boolean
Does contain non spillable battery?
fuel
boolean
Can contain fuel?
ormd
boolean
Does contain orm-d?
battery
string
Battery type
product_condition
string
Condition
country_of_origin
restrictions
[] array
restrictions
tags
[] array
Tags
variants
[] array
Product variants
variantsAttributes
[] array
Product variants attributes
wholesalePrices
[] array
Relation to a product entity
reviews
[] array
Product reviews
upsellingProducts
[] array
Links to related products (relation [this product] -> [related product])
upsellingParentProducts
[] array
Back links from related products (back relation [related product] -> [this product])
product_id
integer
Product unique ID
version
integer
price
string
Product price
sku
string
Product SKU
enabled
boolean
Is product available or not
weight
string
Product weight
useSeparateBox
boolean
Is product shipped in separate box
boxWidth
string
Product box width
boxLength
string
Product box length
boxHeight
string
Product box height
itemsPerBox
integer
How many product items can be placed in a box
free_shipping
boolean
Flag: false - product is shippable, true - product is not shippable
taxable
boolean
If false then the product is free from any taxes
javascript
string
Custom javascript code
arrivalDate
integer
Arrival date (UNIX timestamp)
date
integer
Creation date (UNIX timestamp)
updateDate
integer
Update date (UNIX timestamp)
needProcess
boolean
Is product need process or not
categoryProducts
[] array
Relation to a CategoryProducts entities
order_items
[] array
Product order items
images
[] array
Product images
inventoryEnabled
boolean
Is inventory tracking enabled or not
amount
integer
Amount
lowLimitEnabledCustomer
boolean
Is low limit notification enabled for customer or not
lowLimitEnabled
boolean
Is low limit notification enabled for admin or not
lowLimitAmount
integer
Low limit amount
productClass
taxClass
attributes
[] array
Attributes
attributeValueC
[] array
Attribute value (checkbox)
attributeValueT
[] array
Attribute value (text)
attributeValueS
[] array
Attribute value (select)
attrSepTab
boolean
Show product attributes in a separate tab
quickData
[] array
Quick data
memberships
[] array
Memberships
cleanURLs
[] array
Clean URLs
metaDescType
string
Meta description type
sales
integer
Sales
xcPendingExport
boolean
Flag to exporting entities
default Success <XLite\Model\Product>
Sample response
{"featuredProducts":"<XLite\\Module\\CDev\\FeaturedProducts\\Model\\FeaturedProduct>[] array","attachments":"<XLite\\Module\\CDev\\FileAttachments\\Model\\Product\\Attachment>[] array","ogMeta":"string","useCustomOG":"boolean","marketPrice":"string","pinCodesEnabled":"boolean","autoPinCodes":"boolean","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","views_stats":"<XLite\\Module\\CDev\\ProductAdvisor\\Model\\ProductStats>[] array","purchase_stats":"<XLite\\Module\\CDev\\ProductAdvisor\\Model\\ProductStats>[] array","participateSale":"boolean","discountType":"string","salePriceValue":"string","xcPendingBulkEdit":"boolean","tabs":"<XLite\\Module\\XC\\CustomProductTabs\\Model\\Product\\Tab>[] array","isCustomerAttachmentsAvailable":"boolean","isCustomerAttachmentsRequired":"boolean","facebookMarketingEnabled":"boolean","freeShip":"boolean","freightFixedFee":"string","useAsSegmentCondition":"boolean","exported_pb":"boolean","gpc":"string","gtin":"string","hs_code":"string","mpn":"string","model_number":"string","stock_number":"string","hazmat":"boolean","chemicals":"boolean","pesticide":"boolean","aerosol":"boolean","rppc":"boolean","non_spillable":"boolean","fuel":"boolean","ormd":"boolean","battery":"string","product_condition":"string","country_of_origin":"<XLite\\Model\\Country>","restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","tags":"<XLite\\Module\\XC\\ProductTags\\Model\\Tag>[] array","variants":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>[] array","variantsAttributes":"<XLite\\Model\\Attribute>[] array","wholesalePrices":"<XLite\\Module\\CDev\\Wholesale\\Model\\WholesalePrice>[] array","reviews":"<XLite\\Module\\XC\\Reviews\\Model\\Review>[] array","upsellingProducts":"<XLite\\Module\\XC\\Upselling\\Model\\UpsellingProduct>[] array","upsellingParentProducts":"<XLite\\Module\\XC\\Upselling\\Model\\UpsellingProduct>[] array","product_id":"integer","price":"string","sku":"string","enabled":"boolean","weight":"string","useSeparateBox":"boolean","boxWidth":"string","boxLength":"string","boxHeight":"string","itemsPerBox":"integer","free_shipping":"boolean","taxable":"boolean","javascript":"string","arrivalDate":"integer","date":"integer","updateDate":"integer","needProcess":"boolean","categoryProducts":"<XLite\\Model\\CategoryProducts>[] array","order_items":"<XLite\\Model\\OrderItem>[] array","images":"<XLite\\Model\\Image\\Product\\Image>[] array","inventoryEnabled":"boolean","amount":"integer","lowLimitEnabledCustomer":"boolean","lowLimitEnabled":"boolean","lowLimitAmount":"integer","productClass":"<XLite\\Model\\ProductClass>","taxClass":"<XLite\\Model\\TaxClass>","attributes":"<XLite\\Model\\Attribute>[] array","attributeValueC":"<XLite\\Model\\AttributeValue\\AttributeValueCheckbox>[] array","attributeValueT":"<XLite\\Model\\AttributeValue\\AttributeValueText>[] array","attributeValueS":"<XLite\\Model\\AttributeValue\\AttributeValueSelect>[] array","attrSepTab":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","memberships":"<XLite\\Model\\Membership>[] array","cleanURLs":"<XLite\\Model\\CleanURL>[] array","metaDescType":"string","sales":"integer","xcPendingExport":"boolean"}
featuredProducts
[] array
Featured products (relation)
attachments
[] array
Product attachments
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
marketPrice
string
Product market price
pinCodesEnabled
boolean
Whether pin codes are enabled for this product
autoPinCodes
boolean
Whether to create pin codes automatically
pinCodes
[] array
Pin codes (relation)
views_stats
[] array
Relation to product views statistics
purchase_stats
[] array
Relation to product purchase statistics
participateSale
boolean
Flag, if the product participates in the sale
discountType
string
self::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
boolean
Flag to exporting entities (no need setters and getters)
tabs
[] array
Order tabs
isCustomerAttachmentsAvailable
boolean
Product is available for customer attachments
isCustomerAttachmentsRequired
boolean
Attachment is required for add to cart
facebookMarketingEnabled
boolean
Product is available for Facebook Marketing feed
freeShip
boolean
Is free shipping available for the product
freightFixedFee
string
Shipping freight fixed fee
useAsSegmentCondition
boolean
Use product in segment conditions
exported_pb
boolean
True if product was exported to PB and didn't change after
gpc
string
Global Product Code
gtin
string
Global Trade Identification Number
hs_code
string
Harmony system code
mpn
string
Manufacturer part number
model_number
string
Manufacturer model number
stock_number
string
Manufacturer stock number
hazmat
boolean
Does contain hazardous materials?
chemicals
boolean
Does contain chemicals?
pesticide
boolean
Does contain pesticide?
aerosol
boolean
Does contain aerosol?
rppc
boolean
Does contain plastic container?
non_spillable
boolean
Does contain non spillable battery?
fuel
boolean
Can contain fuel?
ormd
boolean
Does contain orm-d?
battery
string
Battery type
product_condition
string
Condition
country_of_origin
restrictions
[] array
restrictions
tags
[] array
Tags
variants
[] array
Product variants
variantsAttributes
[] array
Product variants attributes
wholesalePrices
[] array
Relation to a product entity
reviews
[] array
Product reviews
upsellingProducts
[] array
Links to related products (relation [this product] -> [related product])
upsellingParentProducts
[] array
Back links from related products (back relation [related product] -> [this product])
product_id
integer
Product unique ID
version
integer
price
string
Product price
sku
string
Product SKU
enabled
boolean
Is product available or not
weight
string
Product weight
useSeparateBox
boolean
Is product shipped in separate box
boxWidth
string
Product box width
boxLength
string
Product box length
boxHeight
string
Product box height
itemsPerBox
integer
How many product items can be placed in a box
free_shipping
boolean
Flag: false - product is shippable, true - product is not shippable
taxable
boolean
If false then the product is free from any taxes
javascript
string
Custom javascript code
arrivalDate
integer
Arrival date (UNIX timestamp)
date
integer
Creation date (UNIX timestamp)
updateDate
integer
Update date (UNIX timestamp)
needProcess
boolean
Is product need process or not
categoryProducts
[] array
Relation to a CategoryProducts entities
order_items
[] array
Product order items
images
[] array
Product images
inventoryEnabled
boolean
Is inventory tracking enabled or not
amount
integer
Amount
lowLimitEnabledCustomer
boolean
Is low limit notification enabled for customer or not
lowLimitEnabled
boolean
Is low limit notification enabled for admin or not
lowLimitAmount
integer
Low limit amount
productClass
taxClass
attributes
[] array
Attributes
attributeValueC
[] array
Attribute value (checkbox)
attributeValueT
[] array
Attribute value (text)
attributeValueS
[] array
Attribute value (select)
attrSepTab
boolean
Show product attributes in a separate tab
quickData
[] array
Quick data
memberships
[] array
Memberships
cleanURLs
[] array
Clean URLs
metaDescType
string
Meta description type
sales
integer
Sales
xcPendingExport
boolean
Flag to exporting entities

DELETE
Delete product by id

id
integer Required
Id value of the Product object
default Success <XLite\Model\Product>
Sample response
{"featuredProducts":"<XLite\\Module\\CDev\\FeaturedProducts\\Model\\FeaturedProduct>[] array","attachments":"<XLite\\Module\\CDev\\FileAttachments\\Model\\Product\\Attachment>[] array","ogMeta":"string","useCustomOG":"boolean","marketPrice":"string","pinCodesEnabled":"boolean","autoPinCodes":"boolean","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","views_stats":"<XLite\\Module\\CDev\\ProductAdvisor\\Model\\ProductStats>[] array","purchase_stats":"<XLite\\Module\\CDev\\ProductAdvisor\\Model\\ProductStats>[] array","participateSale":"boolean","discountType":"string","salePriceValue":"string","xcPendingBulkEdit":"boolean","tabs":"<XLite\\Module\\XC\\CustomProductTabs\\Model\\Product\\Tab>[] array","isCustomerAttachmentsAvailable":"boolean","isCustomerAttachmentsRequired":"boolean","facebookMarketingEnabled":"boolean","freeShip":"boolean","freightFixedFee":"string","useAsSegmentCondition":"boolean","exported_pb":"boolean","gpc":"string","gtin":"string","hs_code":"string","mpn":"string","model_number":"string","stock_number":"string","hazmat":"boolean","chemicals":"boolean","pesticide":"boolean","aerosol":"boolean","rppc":"boolean","non_spillable":"boolean","fuel":"boolean","ormd":"boolean","battery":"string","product_condition":"string","country_of_origin":"<XLite\\Model\\Country>","restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","tags":"<XLite\\Module\\XC\\ProductTags\\Model\\Tag>[] array","variants":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>[] array","variantsAttributes":"<XLite\\Model\\Attribute>[] array","wholesalePrices":"<XLite\\Module\\CDev\\Wholesale\\Model\\WholesalePrice>[] array","reviews":"<XLite\\Module\\XC\\Reviews\\Model\\Review>[] array","upsellingProducts":"<XLite\\Module\\XC\\Upselling\\Model\\UpsellingProduct>[] array","upsellingParentProducts":"<XLite\\Module\\XC\\Upselling\\Model\\UpsellingProduct>[] array","product_id":"integer","price":"string","sku":"string","enabled":"boolean","weight":"string","useSeparateBox":"boolean","boxWidth":"string","boxLength":"string","boxHeight":"string","itemsPerBox":"integer","free_shipping":"boolean","taxable":"boolean","javascript":"string","arrivalDate":"integer","date":"integer","updateDate":"integer","needProcess":"boolean","categoryProducts":"<XLite\\Model\\CategoryProducts>[] array","order_items":"<XLite\\Model\\OrderItem>[] array","images":"<XLite\\Model\\Image\\Product\\Image>[] array","inventoryEnabled":"boolean","amount":"integer","lowLimitEnabledCustomer":"boolean","lowLimitEnabled":"boolean","lowLimitAmount":"integer","productClass":"<XLite\\Model\\ProductClass>","taxClass":"<XLite\\Model\\TaxClass>","attributes":"<XLite\\Model\\Attribute>[] array","attributeValueC":"<XLite\\Model\\AttributeValue\\AttributeValueCheckbox>[] array","attributeValueT":"<XLite\\Model\\AttributeValue\\AttributeValueText>[] array","attributeValueS":"<XLite\\Model\\AttributeValue\\AttributeValueSelect>[] array","attrSepTab":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","memberships":"<XLite\\Model\\Membership>[] array","cleanURLs":"<XLite\\Model\\CleanURL>[] array","metaDescType":"string","sales":"integer","xcPendingExport":"boolean"}
featuredProducts
[] array
Featured products (relation)
attachments
[] array
Product attachments
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
marketPrice
string
Product market price
pinCodesEnabled
boolean
Whether pin codes are enabled for this product
autoPinCodes
boolean
Whether to create pin codes automatically
pinCodes
[] array
Pin codes (relation)
views_stats
[] array
Relation to product views statistics
purchase_stats
[] array
Relation to product purchase statistics
participateSale
boolean
Flag, if the product participates in the sale
discountType
string
self::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
boolean
Flag to exporting entities (no need setters and getters)
tabs
[] array
Order tabs
isCustomerAttachmentsAvailable
boolean
Product is available for customer attachments
isCustomerAttachmentsRequired
boolean
Attachment is required for add to cart
facebookMarketingEnabled
boolean
Product is available for Facebook Marketing feed
freeShip
boolean
Is free shipping available for the product
freightFixedFee
string
Shipping freight fixed fee
useAsSegmentCondition
boolean
Use product in segment conditions
exported_pb
boolean
True if product was exported to PB and didn't change after
gpc
string
Global Product Code
gtin
string
Global Trade Identification Number
hs_code
string
Harmony system code
mpn
string
Manufacturer part number
model_number
string
Manufacturer model number
stock_number
string
Manufacturer stock number
hazmat
boolean
Does contain hazardous materials?
chemicals
boolean
Does contain chemicals?
pesticide
boolean
Does contain pesticide?
aerosol
boolean
Does contain aerosol?
rppc
boolean
Does contain plastic container?
non_spillable
boolean
Does contain non spillable battery?
fuel
boolean
Can contain fuel?
ormd
boolean
Does contain orm-d?
battery
string
Battery type
product_condition
string
Condition
country_of_origin
restrictions
[] array
restrictions
tags
[] array
Tags
variants
[] array
Product variants
variantsAttributes
[] array
Product variants attributes
wholesalePrices
[] array
Relation to a product entity
reviews
[] array
Product reviews
upsellingProducts
[] array
Links to related products (relation [this product] -> [related product])
upsellingParentProducts
[] array
Back links from related products (back relation [related product] -> [this product])
product_id
integer
Product unique ID
version
integer
price
string
Product price
sku
string
Product SKU
enabled
boolean
Is product available or not
weight
string
Product weight
useSeparateBox
boolean
Is product shipped in separate box
boxWidth
string
Product box width
boxLength
string
Product box length
boxHeight
string
Product box height
itemsPerBox
integer
How many product items can be placed in a box
free_shipping
boolean
Flag: false - product is shippable, true - product is not shippable
taxable
boolean
If false then the product is free from any taxes
javascript
string
Custom javascript code
arrivalDate
integer
Arrival date (UNIX timestamp)
date
integer
Creation date (UNIX timestamp)
updateDate
integer
Update date (UNIX timestamp)
needProcess
boolean
Is product need process or not
categoryProducts
[] array
Relation to a CategoryProducts entities
order_items
[] array
Product order items
images
[] array
Product images
inventoryEnabled
boolean
Is inventory tracking enabled or not
amount
integer
Amount
lowLimitEnabledCustomer
boolean
Is low limit notification enabled for customer or not
lowLimitEnabled
boolean
Is low limit notification enabled for admin or not
lowLimitAmount
integer
Low limit amount
productClass
taxClass
attributes
[] array
Attributes
attributeValueC
[] array
Attribute value (checkbox)
attributeValueT
[] array
Attribute value (text)
attributeValueS
[] array
Attribute value (select)
attrSepTab
boolean
Show product attributes in a separate tab
quickData
[] array
Quick data
memberships
[] array
Memberships
cleanURLs
[] array
Clean URLs
metaDescType
string
Meta description type
sales
integer
Sales
xcPendingExport
boolean
Flag to exporting entities

POST
Add new product

<XLite\Model\Product>
featuredProducts
[] array
Featured products (relation)
attachments
[] array
Product attachments
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
marketPrice
string
Product market price
pinCodesEnabled
boolean
Whether pin codes are enabled for this product
autoPinCodes
boolean
Whether to create pin codes automatically
pinCodes
[] array
Pin codes (relation)
views_stats
[] array
Relation to product views statistics
purchase_stats
[] array
Relation to product purchase statistics
participateSale
boolean
Flag, if the product participates in the sale
discountType
string
self::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
boolean
Flag to exporting entities (no need setters and getters)
tabs
[] array
Order tabs
isCustomerAttachmentsAvailable
boolean
Product is available for customer attachments
isCustomerAttachmentsRequired
boolean
Attachment is required for add to cart
facebookMarketingEnabled
boolean
Product is available for Facebook Marketing feed
freeShip
boolean
Is free shipping available for the product
freightFixedFee
string
Shipping freight fixed fee
useAsSegmentCondition
boolean
Use product in segment conditions
exported_pb
boolean
True if product was exported to PB and didn't change after
gpc
string
Global Product Code
gtin
string
Global Trade Identification Number
hs_code
string
Harmony system code
mpn
string
Manufacturer part number
model_number
string
Manufacturer model number
stock_number
string
Manufacturer stock number
hazmat
boolean
Does contain hazardous materials?
chemicals
boolean
Does contain chemicals?
pesticide
boolean
Does contain pesticide?
aerosol
boolean
Does contain aerosol?
rppc
boolean
Does contain plastic container?
non_spillable
boolean
Does contain non spillable battery?
fuel
boolean
Can contain fuel?
ormd
boolean
Does contain orm-d?
battery
string
Battery type
product_condition
string
Condition
country_of_origin
restrictions
[] array
restrictions
tags
[] array
Tags
variants
[] array
Product variants
variantsAttributes
[] array
Product variants attributes
wholesalePrices
[] array
Relation to a product entity
reviews
[] array
Product reviews
upsellingProducts
[] array
Links to related products (relation [this product] -> [related product])
upsellingParentProducts
[] array
Back links from related products (back relation [related product] -> [this product])
product_id
integer
Product unique ID
version
integer
price
string
Product price
sku
string
Product SKU
enabled
boolean
Is product available or not
weight
string
Product weight
useSeparateBox
boolean
Is product shipped in separate box
boxWidth
string
Product box width
boxLength
string
Product box length
boxHeight
string
Product box height
itemsPerBox
integer
How many product items can be placed in a box
free_shipping
boolean
Flag: false - product is shippable, true - product is not shippable
taxable
boolean
If false then the product is free from any taxes
javascript
string
Custom javascript code
arrivalDate
integer
Arrival date (UNIX timestamp)
date
integer
Creation date (UNIX timestamp)
updateDate
integer
Update date (UNIX timestamp)
needProcess
boolean
Is product need process or not
categoryProducts
[] array
Relation to a CategoryProducts entities
order_items
[] array
Product order items
images
[] array
Product images
inventoryEnabled
boolean
Is inventory tracking enabled or not
amount
integer
Amount
lowLimitEnabledCustomer
boolean
Is low limit notification enabled for customer or not
lowLimitEnabled
boolean
Is low limit notification enabled for admin or not
lowLimitAmount
integer
Low limit amount
productClass
taxClass
attributes
[] array
Attributes
attributeValueC
[] array
Attribute value (checkbox)
attributeValueT
[] array
Attribute value (text)
attributeValueS
[] array
Attribute value (select)
attrSepTab
boolean
Show product attributes in a separate tab
quickData
[] array
Quick data
memberships
[] array
Memberships
cleanURLs
[] array
Clean URLs
metaDescType
string
Meta description type
sales
integer
Sales
xcPendingExport
boolean
Flag to exporting entities
default Success <XLite\Model\Product>
Sample response
{"featuredProducts":"<XLite\\Module\\CDev\\FeaturedProducts\\Model\\FeaturedProduct>[] array","attachments":"<XLite\\Module\\CDev\\FileAttachments\\Model\\Product\\Attachment>[] array","ogMeta":"string","useCustomOG":"boolean","marketPrice":"string","pinCodesEnabled":"boolean","autoPinCodes":"boolean","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","views_stats":"<XLite\\Module\\CDev\\ProductAdvisor\\Model\\ProductStats>[] array","purchase_stats":"<XLite\\Module\\CDev\\ProductAdvisor\\Model\\ProductStats>[] array","participateSale":"boolean","discountType":"string","salePriceValue":"string","xcPendingBulkEdit":"boolean","tabs":"<XLite\\Module\\XC\\CustomProductTabs\\Model\\Product\\Tab>[] array","isCustomerAttachmentsAvailable":"boolean","isCustomerAttachmentsRequired":"boolean","facebookMarketingEnabled":"boolean","freeShip":"boolean","freightFixedFee":"string","useAsSegmentCondition":"boolean","exported_pb":"boolean","gpc":"string","gtin":"string","hs_code":"string","mpn":"string","model_number":"string","stock_number":"string","hazmat":"boolean","chemicals":"boolean","pesticide":"boolean","aerosol":"boolean","rppc":"boolean","non_spillable":"boolean","fuel":"boolean","ormd":"boolean","battery":"string","product_condition":"string","country_of_origin":"<XLite\\Model\\Country>","restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","tags":"<XLite\\Module\\XC\\ProductTags\\Model\\Tag>[] array","variants":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>[] array","variantsAttributes":"<XLite\\Model\\Attribute>[] array","wholesalePrices":"<XLite\\Module\\CDev\\Wholesale\\Model\\WholesalePrice>[] array","reviews":"<XLite\\Module\\XC\\Reviews\\Model\\Review>[] array","upsellingProducts":"<XLite\\Module\\XC\\Upselling\\Model\\UpsellingProduct>[] array","upsellingParentProducts":"<XLite\\Module\\XC\\Upselling\\Model\\UpsellingProduct>[] array","product_id":"integer","price":"string","sku":"string","enabled":"boolean","weight":"string","useSeparateBox":"boolean","boxWidth":"string","boxLength":"string","boxHeight":"string","itemsPerBox":"integer","free_shipping":"boolean","taxable":"boolean","javascript":"string","arrivalDate":"integer","date":"integer","updateDate":"integer","needProcess":"boolean","categoryProducts":"<XLite\\Model\\CategoryProducts>[] array","order_items":"<XLite\\Model\\OrderItem>[] array","images":"<XLite\\Model\\Image\\Product\\Image>[] array","inventoryEnabled":"boolean","amount":"integer","lowLimitEnabledCustomer":"boolean","lowLimitEnabled":"boolean","lowLimitAmount":"integer","productClass":"<XLite\\Model\\ProductClass>","taxClass":"<XLite\\Model\\TaxClass>","attributes":"<XLite\\Model\\Attribute>[] array","attributeValueC":"<XLite\\Model\\AttributeValue\\AttributeValueCheckbox>[] array","attributeValueT":"<XLite\\Model\\AttributeValue\\AttributeValueText>[] array","attributeValueS":"<XLite\\Model\\AttributeValue\\AttributeValueSelect>[] array","attrSepTab":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","memberships":"<XLite\\Model\\Membership>[] array","cleanURLs":"<XLite\\Model\\CleanURL>[] array","metaDescType":"string","sales":"integer","xcPendingExport":"boolean"}
featuredProducts
[] array
Featured products (relation)
attachments
[] array
Product attachments
ogMeta
string
Custom Open graph meta tags
useCustomOG
boolean
User Open graph meta tags generator flag
marketPrice
string
Product market price
pinCodesEnabled
boolean
Whether pin codes are enabled for this product
autoPinCodes
boolean
Whether to create pin codes automatically
pinCodes
[] array
Pin codes (relation)
views_stats
[] array
Relation to product views statistics
purchase_stats
[] array
Relation to product purchase statistics
participateSale
boolean
Flag, if the product participates in the sale
discountType
string
self::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
boolean
Flag to exporting entities (no need setters and getters)
tabs
[] array
Order tabs
isCustomerAttachmentsAvailable
boolean
Product is available for customer attachments
isCustomerAttachmentsRequired
boolean
Attachment is required for add to cart
facebookMarketingEnabled
boolean
Product is available for Facebook Marketing feed
freeShip
boolean
Is free shipping available for the product
freightFixedFee
string
Shipping freight fixed fee
useAsSegmentCondition
boolean
Use product in segment conditions
exported_pb
boolean
True if product was exported to PB and didn't change after
gpc
string
Global Product Code
gtin
string
Global Trade Identification Number
hs_code
string
Harmony system code
mpn
string
Manufacturer part number
model_number
string
Manufacturer model number
stock_number
string
Manufacturer stock number
hazmat
boolean
Does contain hazardous materials?
chemicals
boolean
Does contain chemicals?
pesticide
boolean
Does contain pesticide?
aerosol
boolean
Does contain aerosol?
rppc
boolean
Does contain plastic container?
non_spillable
boolean
Does contain non spillable battery?
fuel
boolean
Can contain fuel?
ormd
boolean
Does contain orm-d?
battery
string
Battery type
product_condition
string
Condition
country_of_origin
restrictions
[] array
restrictions
tags
[] array
Tags
variants
[] array
Product variants
variantsAttributes
[] array
Product variants attributes
wholesalePrices
[] array
Relation to a product entity
reviews
[] array
Product reviews
upsellingProducts
[] array
Links to related products (relation [this product] -> [related product])
upsellingParentProducts
[] array
Back links from related products (back relation [related product] -> [this product])
product_id
integer
Product unique ID
version
integer
price
string
Product price
sku
string
Product SKU
enabled
boolean
Is product available or not
weight
string
Product weight
useSeparateBox
boolean
Is product shipped in separate box
boxWidth
string
Product box width
boxLength
string
Product box length
boxHeight
string
Product box height
itemsPerBox
integer
How many product items can be placed in a box
free_shipping
boolean
Flag: false - product is shippable, true - product is not shippable
taxable
boolean
If false then the product is free from any taxes
javascript
string
Custom javascript code
arrivalDate
integer
Arrival date (UNIX timestamp)
date
integer
Creation date (UNIX timestamp)
updateDate
integer
Update date (UNIX timestamp)
needProcess
boolean
Is product need process or not
categoryProducts
[] array
Relation to a CategoryProducts entities
order_items
[] array
Product order items
images
[] array
Product images
inventoryEnabled
boolean
Is inventory tracking enabled or not
amount
integer
Amount
lowLimitEnabledCustomer
boolean
Is low limit notification enabled for customer or not
lowLimitEnabled
boolean
Is low limit notification enabled for admin or not
lowLimitAmount
integer
Low limit amount
productClass
taxClass
attributes
[] array
Attributes
attributeValueC
[] array
Attribute value (checkbox)
attributeValueT
[] array
Attribute value (text)
attributeValueS
[] array
Attribute value (select)
attrSepTab
boolean
Show product attributes in a separate tab
quickData
[] array
Quick data
memberships
[] array
Memberships
cleanURLs
[] array
Clean URLs
metaDescType
string
Meta description type
sales
integer
Sales
xcPendingExport
boolean
Flag to exporting entities