OrderItemAttachmentAttachment (XC\CustomerAttachments)
This repo stores user-created global product tabs.
GET
Retrieve customer attachments by conditions
_cnd[limit]
array
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array
Sets sorting order field
default Success <XLite\Module\XC\CustomerAttachments\Model\OrderItem\Attachment\Attachment>[] array
Sample response
[{"orderItem":{"privateAttachments":"<XLite\\Module\\CDev\\Egoods\\Model\\OrderItem\\PrivateAttachment>[] array","categoryAdded":"string","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","vatRate":"string","capostParcelItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","capostReturnItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","customerAttachments":"<XLite\\Module\\XC\\CustomerAttachments\\Model\\OrderItem\\Attachment\\Attachment>[] array","parcelItems":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ParcelItem>[] array","variant":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>","item_id":"integer","object":"<XLite\\Model\\Product>","name":"string","sku":"string","price":"string","itemNetPrice":"string","discountedSubtotal":"string","amount":"integer","order":"<XLite\\Model\\Order>","surcharges":"<XLite\\Model\\OrderItem\\Surcharge>[] array","attributeValues":"<XLite\\Model\\OrderItem\\AttributeValue>[] array","total":"string","subtotal":"string"},"id":42,"path":"example","fileName":"example","mime":"example","storageType":"example","size":6,"date":23}]
_cnd[limit]
array
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array
Sets sorting order field
default Success <XLite\Module\XC\CustomerAttachments\Model\OrderItem\Attachment\Attachment>[] array
Sample response
[{"orderItem":{"privateAttachments":"<XLite\\Module\\CDev\\Egoods\\Model\\OrderItem\\PrivateAttachment>[] array","categoryAdded":"string","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","vatRate":"string","capostParcelItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","capostReturnItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","customerAttachments":"<XLite\\Module\\XC\\CustomerAttachments\\Model\\OrderItem\\Attachment\\Attachment>[] array","parcelItems":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ParcelItem>[] array","variant":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>","item_id":"integer","object":"<XLite\\Model\\Product>","name":"string","sku":"string","price":"string","itemNetPrice":"string","discountedSubtotal":"string","amount":"integer","order":"<XLite\\Model\\Order>","surcharges":"<XLite\\Model\\OrderItem\\Surcharge>[] array","attributeValues":"<XLite\\Model\\OrderItem\\AttributeValue>[] array","total":"string","subtotal":"string"},"id":42,"path":"example","fileName":"example","mime":"example","storageType":"example","size":6,"date":23}]
GET
Retrieve customer attachment by id
id
integer Required
Id value of the Attachment object
default Success <XLite\Module\XC\CustomerAttachments\Model\OrderItem\Attachment\Attachment>
Sample response
{"orderItem":{"privateAttachments":"<XLite\\Module\\CDev\\Egoods\\Model\\OrderItem\\PrivateAttachment>[] array","categoryAdded":"string","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","vatRate":"string","capostParcelItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","capostReturnItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","customerAttachments":"<XLite\\Module\\XC\\CustomerAttachments\\Model\\OrderItem\\Attachment\\Attachment>[] array","parcelItems":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ParcelItem>[] array","variant":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>","item_id":"integer","object":"<XLite\\Model\\Product>","name":"string","sku":"string","price":"string","itemNetPrice":"string","discountedSubtotal":"string","amount":"integer","order":"<XLite\\Model\\Order>","surcharges":"<XLite\\Model\\OrderItem\\Surcharge>[] array","attributeValues":"<XLite\\Model\\OrderItem\\AttributeValue>[] array","total":"string","subtotal":"string"},"id":42,"path":"example","fileName":"example","mime":"example","storageType":"example","size":6,"date":23}
orderItem
id
integer Required
Id value of the Attachment object
default Success <XLite\Module\XC\CustomerAttachments\Model\OrderItem\Attachment\Attachment>
Sample response
{"orderItem":{"privateAttachments":"<XLite\\Module\\CDev\\Egoods\\Model\\OrderItem\\PrivateAttachment>[] array","categoryAdded":"string","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","vatRate":"string","capostParcelItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","capostReturnItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","customerAttachments":"<XLite\\Module\\XC\\CustomerAttachments\\Model\\OrderItem\\Attachment\\Attachment>[] array","parcelItems":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ParcelItem>[] array","variant":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>","item_id":"integer","object":"<XLite\\Model\\Product>","name":"string","sku":"string","price":"string","itemNetPrice":"string","discountedSubtotal":"string","amount":"integer","order":"<XLite\\Model\\Order>","surcharges":"<XLite\\Model\\OrderItem\\Surcharge>[] array","attributeValues":"<XLite\\Model\\OrderItem\\AttributeValue>[] array","total":"string","subtotal":"string"},"id":42,"path":"example","fileName":"example","mime":"example","storageType":"example","size":6,"date":23}
orderItem
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 customer attachment by id
id
integer Required
Id value of the Attachment object
<XLite\Module\XC\CustomerAttachments\Model\OrderItem\Attachment\Attachment>
orderItem
id
integer Required
Id value of the Attachment object
<XLite\Module\XC\CustomerAttachments\Model\OrderItem\Attachment\Attachment>
orderItem
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\Module\XC\CustomerAttachments\Model\OrderItem\Attachment\Attachment>
Sample response
{"orderItem":{"privateAttachments":"<XLite\\Module\\CDev\\Egoods\\Model\\OrderItem\\PrivateAttachment>[] array","categoryAdded":"string","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","vatRate":"string","capostParcelItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","capostReturnItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","customerAttachments":"<XLite\\Module\\XC\\CustomerAttachments\\Model\\OrderItem\\Attachment\\Attachment>[] array","parcelItems":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ParcelItem>[] array","variant":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>","item_id":"integer","object":"<XLite\\Model\\Product>","name":"string","sku":"string","price":"string","itemNetPrice":"string","discountedSubtotal":"string","amount":"integer","order":"<XLite\\Model\\Order>","surcharges":"<XLite\\Model\\OrderItem\\Surcharge>[] array","attributeValues":"<XLite\\Model\\OrderItem\\AttributeValue>[] array","total":"string","subtotal":"string"},"id":42,"path":"example","fileName":"example","mime":"example","storageType":"example","size":6,"date":23}
orderItem
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 customer attachment by id
id
integer Required
Id value of the Attachment object
default Success <XLite\Module\XC\CustomerAttachments\Model\OrderItem\Attachment\Attachment>
Sample response
{"orderItem":{"privateAttachments":"<XLite\\Module\\CDev\\Egoods\\Model\\OrderItem\\PrivateAttachment>[] array","categoryAdded":"string","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","vatRate":"string","capostParcelItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","capostReturnItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","customerAttachments":"<XLite\\Module\\XC\\CustomerAttachments\\Model\\OrderItem\\Attachment\\Attachment>[] array","parcelItems":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ParcelItem>[] array","variant":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>","item_id":"integer","object":"<XLite\\Model\\Product>","name":"string","sku":"string","price":"string","itemNetPrice":"string","discountedSubtotal":"string","amount":"integer","order":"<XLite\\Model\\Order>","surcharges":"<XLite\\Model\\OrderItem\\Surcharge>[] array","attributeValues":"<XLite\\Model\\OrderItem\\AttributeValue>[] array","total":"string","subtotal":"string"},"id":42,"path":"example","fileName":"example","mime":"example","storageType":"example","size":6,"date":23}
orderItem
id
integer Required
Id value of the Attachment object
default Success <XLite\Module\XC\CustomerAttachments\Model\OrderItem\Attachment\Attachment>
Sample response
{"orderItem":{"privateAttachments":"<XLite\\Module\\CDev\\Egoods\\Model\\OrderItem\\PrivateAttachment>[] array","categoryAdded":"string","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","vatRate":"string","capostParcelItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","capostReturnItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","customerAttachments":"<XLite\\Module\\XC\\CustomerAttachments\\Model\\OrderItem\\Attachment\\Attachment>[] array","parcelItems":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ParcelItem>[] array","variant":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>","item_id":"integer","object":"<XLite\\Model\\Product>","name":"string","sku":"string","price":"string","itemNetPrice":"string","discountedSubtotal":"string","amount":"integer","order":"<XLite\\Model\\Order>","surcharges":"<XLite\\Model\\OrderItem\\Surcharge>[] array","attributeValues":"<XLite\\Model\\OrderItem\\AttributeValue>[] array","total":"string","subtotal":"string"},"id":42,"path":"example","fileName":"example","mime":"example","storageType":"example","size":6,"date":23}
orderItem
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 customer attachment
<XLite\Module\XC\CustomerAttachments\Model\OrderItem\Attachment\Attachment>
orderItem
<XLite\Module\XC\CustomerAttachments\Model\OrderItem\Attachment\Attachment>
orderItem
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\Module\XC\CustomerAttachments\Model\OrderItem\Attachment\Attachment>
Sample response
{"orderItem":{"privateAttachments":"<XLite\\Module\\CDev\\Egoods\\Model\\OrderItem\\PrivateAttachment>[] array","categoryAdded":"string","pinCodes":"<XLite\\Module\\CDev\\PINCodes\\Model\\PinCode>[] array","vatRate":"string","capostParcelItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel\\Item>[] array","capostReturnItems":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn\\Item>[] array","customerAttachments":"<XLite\\Module\\XC\\CustomerAttachments\\Model\\OrderItem\\Attachment\\Attachment>[] array","parcelItems":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ParcelItem>[] array","variant":"<XLite\\Module\\XC\\ProductVariants\\Model\\ProductVariant>","item_id":"integer","object":"<XLite\\Model\\Product>","name":"string","sku":"string","price":"string","itemNetPrice":"string","discountedSubtotal":"string","amount":"integer","order":"<XLite\\Model\\Order>","surcharges":"<XLite\\Model\\OrderItem\\Surcharge>[] array","attributeValues":"<XLite\\Model\\OrderItem\\AttributeValue>[] array","total":"string","subtotal":"string"},"id":42,"path":"example","fileName":"example","mime":"example","storageType":"example","size":6,"date":23}
orderItem
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)