GET
Retrieve order items by conditions

_cnd[order]
integer 
Filters order items by order id
_cnd[limit]
array 
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array 
Sets sorting order field
default Success <XLite\Model\OrderItem>[] array
Sample response
[{"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"}]

GET
Retrieve order item by id

id
integer Required
Id value of the OrderItem object
default Success <XLite\Model\OrderItem>
Sample response
{"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"}
privateAttachments
[] array
Order items
categoryAdded
string
Category added name
pinCodes
[] array
Pin codes (relation)
vatRate
string
Item VAT rate: (e.g. 10%, 10)
capostParcelItems
[] array
Canada Post parcel items (reference to the Canada Post parcel item model)
capostReturnItems
[] array
Canada Post return items (reference to the Canada Post return item model)
customerAttachments
[] array
Customer file attachments
parcelItems
[] array
Pitney Bowes order association
variant
item_id
integer
Primary key
object
name
string
Item name
sku
string
Item SKU
price
string
Item price
itemNetPrice
string
Item net price
discountedSubtotal
string
Item discounted subtotal
amount
integer
Item quantity
order
surcharges
[] array
Order item surcharges
attributeValues
[] array
Attribute values
total
string
Total
subtotal
string
Subtotal

PUT
Update order item by id

id
integer Required
Id value of the OrderItem object
<XLite\Model\OrderItem>
privateAttachments
[] array
Order items
categoryAdded
string
Category added name
pinCodes
[] array
Pin codes (relation)
vatRate
string
Item VAT rate: (e.g. 10%, 10)
capostParcelItems
[] array
Canada Post parcel items (reference to the Canada Post parcel item model)
capostReturnItems
[] array
Canada Post return items (reference to the Canada Post return item model)
customerAttachments
[] array
Customer file attachments
parcelItems
[] array
Pitney Bowes order association
variant
item_id
integer
Primary key
object
name
string
Item name
sku
string
Item SKU
price
string
Item price
itemNetPrice
string
Item net price
discountedSubtotal
string
Item discounted subtotal
amount
integer
Item quantity
order
surcharges
[] array
Order item surcharges
attributeValues
[] array
Attribute values
total
string
Total
subtotal
string
Subtotal
default Success <XLite\Model\OrderItem>
Sample response
{"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"}
privateAttachments
[] array
Order items
categoryAdded
string
Category added name
pinCodes
[] array
Pin codes (relation)
vatRate
string
Item VAT rate: (e.g. 10%, 10)
capostParcelItems
[] array
Canada Post parcel items (reference to the Canada Post parcel item model)
capostReturnItems
[] array
Canada Post return items (reference to the Canada Post return item model)
customerAttachments
[] array
Customer file attachments
parcelItems
[] array
Pitney Bowes order association
variant
item_id
integer
Primary key
object
name
string
Item name
sku
string
Item SKU
price
string
Item price
itemNetPrice
string
Item net price
discountedSubtotal
string
Item discounted subtotal
amount
integer
Item quantity
order
surcharges
[] array
Order item surcharges
attributeValues
[] array
Attribute values
total
string
Total
subtotal
string
Subtotal

DELETE
Delete order item by id

id
integer Required
Id value of the OrderItem object
default Success <XLite\Model\OrderItem>
Sample response
{"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"}
privateAttachments
[] array
Order items
categoryAdded
string
Category added name
pinCodes
[] array
Pin codes (relation)
vatRate
string
Item VAT rate: (e.g. 10%, 10)
capostParcelItems
[] array
Canada Post parcel items (reference to the Canada Post parcel item model)
capostReturnItems
[] array
Canada Post return items (reference to the Canada Post return item model)
customerAttachments
[] array
Customer file attachments
parcelItems
[] array
Pitney Bowes order association
variant
item_id
integer
Primary key
object
name
string
Item name
sku
string
Item SKU
price
string
Item price
itemNetPrice
string
Item net price
discountedSubtotal
string
Item discounted subtotal
amount
integer
Item quantity
order
surcharges
[] array
Order item surcharges
attributeValues
[] array
Attribute values
total
string
Total
subtotal
string
Subtotal

POST
Add new order item

<XLite\Model\OrderItem>
privateAttachments
[] array
Order items
categoryAdded
string
Category added name
pinCodes
[] array
Pin codes (relation)
vatRate
string
Item VAT rate: (e.g. 10%, 10)
capostParcelItems
[] array
Canada Post parcel items (reference to the Canada Post parcel item model)
capostReturnItems
[] array
Canada Post return items (reference to the Canada Post return item model)
customerAttachments
[] array
Customer file attachments
parcelItems
[] array
Pitney Bowes order association
variant
item_id
integer
Primary key
object
name
string
Item name
sku
string
Item SKU
price
string
Item price
itemNetPrice
string
Item net price
discountedSubtotal
string
Item discounted subtotal
amount
integer
Item quantity
order
surcharges
[] array
Order item surcharges
attributeValues
[] array
Attribute values
total
string
Total
subtotal
string
Subtotal
default Success <XLite\Model\OrderItem>
Sample response
{"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"}
privateAttachments
[] array
Order items
categoryAdded
string
Category added name
pinCodes
[] array
Pin codes (relation)
vatRate
string
Item VAT rate: (e.g. 10%, 10)
capostParcelItems
[] array
Canada Post parcel items (reference to the Canada Post parcel item model)
capostReturnItems
[] array
Canada Post return items (reference to the Canada Post return item model)
customerAttachments
[] array
Customer file attachments
parcelItems
[] array
Pitney Bowes order association
variant
item_id
integer
Primary key
object
name
string
Item name
sku
string
Item SKU
price
string
Item price
itemNetPrice
string
Item net price
discountedSubtotal
string
Item discounted subtotal
amount
integer
Item quantity
order
surcharges
[] array
Order item surcharges
attributeValues
[] array
Attribute values
total
string
Total
subtotal
string
Subtotal