OrderItem\Surcharge
GET
Retrieve all order item surcharges
_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\Surcharge>[] array
Sample response
[{"owner":{"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":40,"type":"example","code":"example","class":"example","include":false,"available":false,"value":"example","name":"example","weight":18}]
_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\Surcharge>[] array
Sample response
[{"owner":{"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":40,"type":"example","code":"example","class":"example","include":false,"available":false,"value":"example","name":"example","weight":18}]
GET
Retrieve order item surcharge by id
id
integer Required
Id value of the Surcharge object
default Success <XLite\Model\OrderItem\Surcharge>
Sample response
{"owner":{"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":40,"type":"example","code":"example","class":"example","include":false,"available":false,"value":"example","name":"example","weight":18}
owner
id
integer Required
Id value of the Surcharge object
default Success <XLite\Model\OrderItem\Surcharge>
Sample response
{"owner":{"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":40,"type":"example","code":"example","class":"example","include":false,"available":false,"value":"example","name":"example","weight":18}
owner
id
integer
ID
type
string
Type
code
string
Code
class
string
Control class name
include
boolean
Surcharge include flag
available
boolean
Surcharge evailability
value
string
Value
name
string
Name (stored)
weight
integer
Weight
PUT
Update order item surcharge by id
id
integer Required
Id value of the Surcharge object
<XLite\Model\OrderItem\Surcharge>
owner
id
integer Required
Id value of the Surcharge object
<XLite\Model\OrderItem\Surcharge>
owner
id
integer
ID
type
string
Type
code
string
Code
class
string
Control class name
include
boolean
Surcharge include flag
available
boolean
Surcharge evailability
value
string
Value
name
string
Name (stored)
weight
integer
Weight
default Success <XLite\Model\OrderItem\Surcharge>
Sample response
{"owner":{"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":40,"type":"example","code":"example","class":"example","include":false,"available":false,"value":"example","name":"example","weight":18}
owner
id
integer
ID
type
string
Type
code
string
Code
class
string
Control class name
include
boolean
Surcharge include flag
available
boolean
Surcharge evailability
value
string
Value
name
string
Name (stored)
weight
integer
Weight
DELETE
Delete order item surcharge by id
id
integer Required
Id value of the Surcharge object
default Success <XLite\Model\OrderItem\Surcharge>
Sample response
{"owner":{"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":40,"type":"example","code":"example","class":"example","include":false,"available":false,"value":"example","name":"example","weight":18}
owner
id
integer Required
Id value of the Surcharge object
default Success <XLite\Model\OrderItem\Surcharge>
Sample response
{"owner":{"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":40,"type":"example","code":"example","class":"example","include":false,"available":false,"value":"example","name":"example","weight":18}
owner
id
integer
ID
type
string
Type
code
string
Code
class
string
Control class name
include
boolean
Surcharge include flag
available
boolean
Surcharge evailability
value
string
Value
name
string
Name (stored)
weight
integer
Weight
POST
Add new order item surcharge
<XLite\Model\OrderItem\Surcharge>
owner
<XLite\Model\OrderItem\Surcharge>
owner
id
integer
ID
type
string
Type
code
string
Code
class
string
Control class name
include
boolean
Surcharge include flag
available
boolean
Surcharge evailability
value
string
Value
name
string
Name (stored)
weight
integer
Weight
default Success <XLite\Model\OrderItem\Surcharge>
Sample response
{"owner":{"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":40,"type":"example","code":"example","class":"example","include":false,"available":false,"value":"example","name":"example","weight":18}
owner
id
integer
ID
type
string
Type
code
string
Code
class
string
Control class name
include
boolean
Surcharge include flag
available
boolean
Surcharge evailability
value
string
Value
name
string
Name (stored)
weight
integer
Weight