GET
Retrieve all product images

_cnd[limit]
array 
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array 
Sets sorting order field
default Success <XLite\Model\Image\Product\Image>[] array
Sample response
[{"orderby":9,"product":{"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"},"alt":"example","s3icons":["undefined"],"needMigration":false,"width":69,"height":44,"hash":"example","needProcess":false,"id":60,"path":"example","fileName":"example","mime":"example","storageType":"example","size":62,"date":46}]

GET
Retrieve product image by id

id
integer Required
Id value of the Image object
default Success <XLite\Model\Image\Product\Image>
Sample response
{"orderby":9,"product":{"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"},"alt":"example","s3icons":["undefined"],"needMigration":false,"width":69,"height":44,"hash":"example","needProcess":false,"id":60,"path":"example","fileName":"example","mime":"example","storageType":"example","size":62,"date":46}
orderby
integer
Image position
product
alt
string
Alternative image text
s3icons
anything[] array
S3 icons cache
needMigration
boolean
Flag: Is need migration of image to S3
width
integer
Width
height
integer
Height
hash
string
Image hash
needProcess
boolean
Is image need process or not
id
integer
Unique id
path
string
Path (URL or file name in storage directory)
fileName
string
File name
mime
string
MIME type
storageType
string
Storage type
size
integer
Size
date
integer
Create / modify date (UNIX timestamp)

PUT
Update product image by id

id
integer Required
Id value of the Image object
<XLite\Model\Image\Product\Image>
orderby
integer
Image position
product
alt
string
Alternative image text
s3icons
anything[] array
S3 icons cache
needMigration
boolean
Flag: Is need migration of image to S3
width
integer
Width
height
integer
Height
hash
string
Image hash
needProcess
boolean
Is image need process or not
id
integer
Unique id
path
string
Path (URL or file name in storage directory)
fileName
string
File name
mime
string
MIME type
storageType
string
Storage type
size
integer
Size
date
integer
Create / modify date (UNIX timestamp)
default Success <XLite\Model\Image\Product\Image>
Sample response
{"orderby":9,"product":{"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"},"alt":"example","s3icons":["undefined"],"needMigration":false,"width":69,"height":44,"hash":"example","needProcess":false,"id":60,"path":"example","fileName":"example","mime":"example","storageType":"example","size":62,"date":46}
orderby
integer
Image position
product
alt
string
Alternative image text
s3icons
anything[] array
S3 icons cache
needMigration
boolean
Flag: Is need migration of image to S3
width
integer
Width
height
integer
Height
hash
string
Image hash
needProcess
boolean
Is image need process or not
id
integer
Unique id
path
string
Path (URL or file name in storage directory)
fileName
string
File name
mime
string
MIME type
storageType
string
Storage type
size
integer
Size
date
integer
Create / modify date (UNIX timestamp)

DELETE
Delete product image by id

id
integer Required
Id value of the Image object
default Success <XLite\Model\Image\Product\Image>
Sample response
{"orderby":9,"product":{"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"},"alt":"example","s3icons":["undefined"],"needMigration":false,"width":69,"height":44,"hash":"example","needProcess":false,"id":60,"path":"example","fileName":"example","mime":"example","storageType":"example","size":62,"date":46}
orderby
integer
Image position
product
alt
string
Alternative image text
s3icons
anything[] array
S3 icons cache
needMigration
boolean
Flag: Is need migration of image to S3
width
integer
Width
height
integer
Height
hash
string
Image hash
needProcess
boolean
Is image need process or not
id
integer
Unique id
path
string
Path (URL or file name in storage directory)
fileName
string
File name
mime
string
MIME type
storageType
string
Storage type
size
integer
Size
date
integer
Create / modify date (UNIX timestamp)

POST
Add new product image

<XLite\Model\Image\Product\Image>
orderby
integer
Image position
product
alt
string
Alternative image text
s3icons
anything[] array
S3 icons cache
needMigration
boolean
Flag: Is need migration of image to S3
width
integer
Width
height
integer
Height
hash
string
Image hash
needProcess
boolean
Is image need process or not
id
integer
Unique id
path
string
Path (URL or file name in storage directory)
fileName
string
File name
mime
string
MIME type
storageType
string
Storage type
size
integer
Size
date
integer
Create / modify date (UNIX timestamp)
default Success <XLite\Model\Image\Product\Image>
Sample response
{"orderby":9,"product":{"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"},"alt":"example","s3icons":["undefined"],"needMigration":false,"width":69,"height":44,"hash":"example","needProcess":false,"id":60,"path":"example","fileName":"example","mime":"example","storageType":"example","size":62,"date":46}
orderby
integer
Image position
product
alt
string
Alternative image text
s3icons
anything[] array
S3 icons cache
needMigration
boolean
Flag: Is need migration of image to S3
width
integer
Width
height
integer
Height
hash
string
Image hash
needProcess
boolean
Is image need process or not
id
integer
Unique id
path
string
Path (URL or file name in storage directory)
fileName
string
File name
mime
string
MIME type
storageType
string
Storage type
size
integer
Size
date
integer
Create / modify date (UNIX timestamp)