Commission (XC\MultiVendor)
This repo stores vendor commission from the orders.
GET
Retrieve vendor commission records 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\MultiVendor\Model\Commission>[] array
Sample response
[{"id":34,"value":"example","status":"example","auto":true,"order":{"usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","uspsShipment":"<XLite\\Module\\CDev\\USPS\\Model\\Shipment>[] array","capostParcels":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel>[] array","capostReturns":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn>[] array","capostOffice":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\PostOffice>","giftWrapping":"boolean","greetingMessage":"string","mailchimpStoreId":"string","mandrill_mails":"<XLite\\Module\\XC\\Mandrill\\Model\\MandrillMail>[] array","not_finished_order":"<XLite\\Model\\Order>","pbOrder":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBOrder>","conversation":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>","order_id":"integer","profile":"<XLite\\Model\\Profile>","orig_profile":"<XLite\\Model\\Profile>","shipping_id":"integer","shipping_method_name":"string","payment_method_name":"string","tracking":"string","date":"integer","lastRenewDate":"integer","paymentStatus":"<XLite\\Model\\Order\\Status\\Payment>","shippingStatus":"<XLite\\Model\\Order\\Status\\Shipping>","notes":"string","adminNotes":"string","details":"<XLite\\Model\\OrderDetail>[] array","trackingNumbers":"<XLite\\Model\\OrderTrackingNumber>[] array","events":"<XLite\\Model\\OrderHistoryEvents>[] array","items":"<XLite\\Model\\OrderItem>[] array","surcharges":"<XLite\\Model\\Order\\Surcharge>[] array","payment_transactions":"<XLite\\Model\\Payment\\Transaction>[] array","currency":"<XLite\\Model\\Currency>","orderNumber":"string","recent":"boolean","xcPendingExport":"boolean","total":"string","subtotal":"string"},"taxesOwner":"example"}]
_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\MultiVendor\Model\Commission>[] array
Sample response
[{"id":34,"value":"example","status":"example","auto":true,"order":{"usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","uspsShipment":"<XLite\\Module\\CDev\\USPS\\Model\\Shipment>[] array","capostParcels":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel>[] array","capostReturns":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn>[] array","capostOffice":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\PostOffice>","giftWrapping":"boolean","greetingMessage":"string","mailchimpStoreId":"string","mandrill_mails":"<XLite\\Module\\XC\\Mandrill\\Model\\MandrillMail>[] array","not_finished_order":"<XLite\\Model\\Order>","pbOrder":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBOrder>","conversation":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>","order_id":"integer","profile":"<XLite\\Model\\Profile>","orig_profile":"<XLite\\Model\\Profile>","shipping_id":"integer","shipping_method_name":"string","payment_method_name":"string","tracking":"string","date":"integer","lastRenewDate":"integer","paymentStatus":"<XLite\\Model\\Order\\Status\\Payment>","shippingStatus":"<XLite\\Model\\Order\\Status\\Shipping>","notes":"string","adminNotes":"string","details":"<XLite\\Model\\OrderDetail>[] array","trackingNumbers":"<XLite\\Model\\OrderTrackingNumber>[] array","events":"<XLite\\Model\\OrderHistoryEvents>[] array","items":"<XLite\\Model\\OrderItem>[] array","surcharges":"<XLite\\Model\\Order\\Surcharge>[] array","payment_transactions":"<XLite\\Model\\Payment\\Transaction>[] array","currency":"<XLite\\Model\\Currency>","orderNumber":"string","recent":"boolean","xcPendingExport":"boolean","total":"string","subtotal":"string"},"taxesOwner":"example"}]
GET
Retrieve vendor commission record by id
id
integer Required
Id value of the Commission object
default Success <XLite\Module\XC\MultiVendor\Model\Commission>
Sample response
{"id":34,"value":"example","status":"example","auto":true,"order":{"usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","uspsShipment":"<XLite\\Module\\CDev\\USPS\\Model\\Shipment>[] array","capostParcels":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel>[] array","capostReturns":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn>[] array","capostOffice":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\PostOffice>","giftWrapping":"boolean","greetingMessage":"string","mailchimpStoreId":"string","mandrill_mails":"<XLite\\Module\\XC\\Mandrill\\Model\\MandrillMail>[] array","not_finished_order":"<XLite\\Model\\Order>","pbOrder":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBOrder>","conversation":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>","order_id":"integer","profile":"<XLite\\Model\\Profile>","orig_profile":"<XLite\\Model\\Profile>","shipping_id":"integer","shipping_method_name":"string","payment_method_name":"string","tracking":"string","date":"integer","lastRenewDate":"integer","paymentStatus":"<XLite\\Model\\Order\\Status\\Payment>","shippingStatus":"<XLite\\Model\\Order\\Status\\Shipping>","notes":"string","adminNotes":"string","details":"<XLite\\Model\\OrderDetail>[] array","trackingNumbers":"<XLite\\Model\\OrderTrackingNumber>[] array","events":"<XLite\\Model\\OrderHistoryEvents>[] array","items":"<XLite\\Model\\OrderItem>[] array","surcharges":"<XLite\\Model\\Order\\Surcharge>[] array","payment_transactions":"<XLite\\Model\\Payment\\Transaction>[] array","currency":"<XLite\\Model\\Currency>","orderNumber":"string","recent":"boolean","xcPendingExport":"boolean","total":"string","subtotal":"string"},"taxesOwner":"example"}
id
integer
Id
value
string
Commission value
status
string
Status
auto
boolean
Auto paid state
order
id
integer Required
Id value of the Commission object
default Success <XLite\Module\XC\MultiVendor\Model\Commission>
Sample response
{"id":34,"value":"example","status":"example","auto":true,"order":{"usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","uspsShipment":"<XLite\\Module\\CDev\\USPS\\Model\\Shipment>[] array","capostParcels":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel>[] array","capostReturns":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn>[] array","capostOffice":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\PostOffice>","giftWrapping":"boolean","greetingMessage":"string","mailchimpStoreId":"string","mandrill_mails":"<XLite\\Module\\XC\\Mandrill\\Model\\MandrillMail>[] array","not_finished_order":"<XLite\\Model\\Order>","pbOrder":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBOrder>","conversation":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>","order_id":"integer","profile":"<XLite\\Model\\Profile>","orig_profile":"<XLite\\Model\\Profile>","shipping_id":"integer","shipping_method_name":"string","payment_method_name":"string","tracking":"string","date":"integer","lastRenewDate":"integer","paymentStatus":"<XLite\\Model\\Order\\Status\\Payment>","shippingStatus":"<XLite\\Model\\Order\\Status\\Shipping>","notes":"string","adminNotes":"string","details":"<XLite\\Model\\OrderDetail>[] array","trackingNumbers":"<XLite\\Model\\OrderTrackingNumber>[] array","events":"<XLite\\Model\\OrderHistoryEvents>[] array","items":"<XLite\\Model\\OrderItem>[] array","surcharges":"<XLite\\Model\\Order\\Surcharge>[] array","payment_transactions":"<XLite\\Model\\Payment\\Transaction>[] array","currency":"<XLite\\Model\\Currency>","orderNumber":"string","recent":"boolean","xcPendingExport":"boolean","total":"string","subtotal":"string"},"taxesOwner":"example"}
id
integer
Id
value
string
Commission value
status
string
Status
auto
boolean
Auto paid state
order
taxesOwner
string
Status
PUT
Update vendor commission record by id
id
integer Required
Id value of the Commission object
<XLite\Module\XC\MultiVendor\Model\Commission>
id
integer
Id
value
string
Commission value
status
string
Status
auto
boolean
Auto paid state
order
id
integer Required
Id value of the Commission object
<XLite\Module\XC\MultiVendor\Model\Commission>
id
integer
Id
value
string
Commission value
status
string
Status
auto
boolean
Auto paid state
order
taxesOwner
string
Status
default Success <XLite\Module\XC\MultiVendor\Model\Commission>
Sample response
{"id":34,"value":"example","status":"example","auto":true,"order":{"usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","uspsShipment":"<XLite\\Module\\CDev\\USPS\\Model\\Shipment>[] array","capostParcels":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel>[] array","capostReturns":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn>[] array","capostOffice":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\PostOffice>","giftWrapping":"boolean","greetingMessage":"string","mailchimpStoreId":"string","mandrill_mails":"<XLite\\Module\\XC\\Mandrill\\Model\\MandrillMail>[] array","not_finished_order":"<XLite\\Model\\Order>","pbOrder":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBOrder>","conversation":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>","order_id":"integer","profile":"<XLite\\Model\\Profile>","orig_profile":"<XLite\\Model\\Profile>","shipping_id":"integer","shipping_method_name":"string","payment_method_name":"string","tracking":"string","date":"integer","lastRenewDate":"integer","paymentStatus":"<XLite\\Model\\Order\\Status\\Payment>","shippingStatus":"<XLite\\Model\\Order\\Status\\Shipping>","notes":"string","adminNotes":"string","details":"<XLite\\Model\\OrderDetail>[] array","trackingNumbers":"<XLite\\Model\\OrderTrackingNumber>[] array","events":"<XLite\\Model\\OrderHistoryEvents>[] array","items":"<XLite\\Model\\OrderItem>[] array","surcharges":"<XLite\\Model\\Order\\Surcharge>[] array","payment_transactions":"<XLite\\Model\\Payment\\Transaction>[] array","currency":"<XLite\\Model\\Currency>","orderNumber":"string","recent":"boolean","xcPendingExport":"boolean","total":"string","subtotal":"string"},"taxesOwner":"example"}
id
integer
Id
value
string
Commission value
status
string
Status
auto
boolean
Auto paid state
order
taxesOwner
string
Status
DELETE
Delete vendor commission record by id
id
integer Required
Id value of the Commission object
default Success <XLite\Module\XC\MultiVendor\Model\Commission>
Sample response
{"id":34,"value":"example","status":"example","auto":true,"order":{"usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","uspsShipment":"<XLite\\Module\\CDev\\USPS\\Model\\Shipment>[] array","capostParcels":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel>[] array","capostReturns":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn>[] array","capostOffice":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\PostOffice>","giftWrapping":"boolean","greetingMessage":"string","mailchimpStoreId":"string","mandrill_mails":"<XLite\\Module\\XC\\Mandrill\\Model\\MandrillMail>[] array","not_finished_order":"<XLite\\Model\\Order>","pbOrder":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBOrder>","conversation":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>","order_id":"integer","profile":"<XLite\\Model\\Profile>","orig_profile":"<XLite\\Model\\Profile>","shipping_id":"integer","shipping_method_name":"string","payment_method_name":"string","tracking":"string","date":"integer","lastRenewDate":"integer","paymentStatus":"<XLite\\Model\\Order\\Status\\Payment>","shippingStatus":"<XLite\\Model\\Order\\Status\\Shipping>","notes":"string","adminNotes":"string","details":"<XLite\\Model\\OrderDetail>[] array","trackingNumbers":"<XLite\\Model\\OrderTrackingNumber>[] array","events":"<XLite\\Model\\OrderHistoryEvents>[] array","items":"<XLite\\Model\\OrderItem>[] array","surcharges":"<XLite\\Model\\Order\\Surcharge>[] array","payment_transactions":"<XLite\\Model\\Payment\\Transaction>[] array","currency":"<XLite\\Model\\Currency>","orderNumber":"string","recent":"boolean","xcPendingExport":"boolean","total":"string","subtotal":"string"},"taxesOwner":"example"}
id
integer
Id
value
string
Commission value
status
string
Status
auto
boolean
Auto paid state
order
id
integer Required
Id value of the Commission object
default Success <XLite\Module\XC\MultiVendor\Model\Commission>
Sample response
{"id":34,"value":"example","status":"example","auto":true,"order":{"usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","uspsShipment":"<XLite\\Module\\CDev\\USPS\\Model\\Shipment>[] array","capostParcels":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel>[] array","capostReturns":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn>[] array","capostOffice":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\PostOffice>","giftWrapping":"boolean","greetingMessage":"string","mailchimpStoreId":"string","mandrill_mails":"<XLite\\Module\\XC\\Mandrill\\Model\\MandrillMail>[] array","not_finished_order":"<XLite\\Model\\Order>","pbOrder":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBOrder>","conversation":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>","order_id":"integer","profile":"<XLite\\Model\\Profile>","orig_profile":"<XLite\\Model\\Profile>","shipping_id":"integer","shipping_method_name":"string","payment_method_name":"string","tracking":"string","date":"integer","lastRenewDate":"integer","paymentStatus":"<XLite\\Model\\Order\\Status\\Payment>","shippingStatus":"<XLite\\Model\\Order\\Status\\Shipping>","notes":"string","adminNotes":"string","details":"<XLite\\Model\\OrderDetail>[] array","trackingNumbers":"<XLite\\Model\\OrderTrackingNumber>[] array","events":"<XLite\\Model\\OrderHistoryEvents>[] array","items":"<XLite\\Model\\OrderItem>[] array","surcharges":"<XLite\\Model\\Order\\Surcharge>[] array","payment_transactions":"<XLite\\Model\\Payment\\Transaction>[] array","currency":"<XLite\\Model\\Currency>","orderNumber":"string","recent":"boolean","xcPendingExport":"boolean","total":"string","subtotal":"string"},"taxesOwner":"example"}
id
integer
Id
value
string
Commission value
status
string
Status
auto
boolean
Auto paid state
order
taxesOwner
string
Status
POST
Add vendor commission record
<XLite\Module\XC\MultiVendor\Model\Commission>
id
integer
Id
value
string
Commission value
status
string
Status
auto
boolean
Auto paid state
order
<XLite\Module\XC\MultiVendor\Model\Commission>
id
integer
Id
value
string
Commission value
status
string
Status
auto
boolean
Auto paid state
order
taxesOwner
string
Status
default Success <XLite\Module\XC\MultiVendor\Model\Commission>
Sample response
{"id":34,"value":"example","status":"example","auto":true,"order":{"usedCoupons":"<XLite\\Module\\CDev\\Coupons\\Model\\UsedCoupon>[] array","uspsShipment":"<XLite\\Module\\CDev\\USPS\\Model\\Shipment>[] array","capostParcels":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\Parcel>[] array","capostReturns":"<XLite\\Module\\XC\\CanadaPost\\Model\\ProductsReturn>[] array","capostOffice":"<XLite\\Module\\XC\\CanadaPost\\Model\\Order\\PostOffice>","giftWrapping":"boolean","greetingMessage":"string","mailchimpStoreId":"string","mandrill_mails":"<XLite\\Module\\XC\\Mandrill\\Model\\MandrillMail>[] array","not_finished_order":"<XLite\\Model\\Order>","pbOrder":"<XLite\\Module\\XC\\PitneyBowes\\Model\\PBOrder>","conversation":"<XLite\\Module\\XC\\VendorMessages\\Model\\Conversation>","order_id":"integer","profile":"<XLite\\Model\\Profile>","orig_profile":"<XLite\\Model\\Profile>","shipping_id":"integer","shipping_method_name":"string","payment_method_name":"string","tracking":"string","date":"integer","lastRenewDate":"integer","paymentStatus":"<XLite\\Model\\Order\\Status\\Payment>","shippingStatus":"<XLite\\Model\\Order\\Status\\Shipping>","notes":"string","adminNotes":"string","details":"<XLite\\Model\\OrderDetail>[] array","trackingNumbers":"<XLite\\Model\\OrderTrackingNumber>[] array","events":"<XLite\\Model\\OrderHistoryEvents>[] array","items":"<XLite\\Model\\OrderItem>[] array","surcharges":"<XLite\\Model\\Order\\Surcharge>[] array","payment_transactions":"<XLite\\Model\\Payment\\Transaction>[] array","currency":"<XLite\\Model\\Currency>","orderNumber":"string","recent":"boolean","xcPendingExport":"boolean","total":"string","subtotal":"string"},"taxesOwner":"example"}
id
integer
Id
value
string
Commission value
status
string
Status
auto
boolean
Auto paid state
order
taxesOwner
string
Status