VolumeDiscount (CDev\VolumeDiscounts)
Volume discount record keeps data about discount tiers
GET
Retrieve volume discounts 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\CDev\VolumeDiscounts\Model\VolumeDiscount>[] array
Sample response
[{"id":61,"value":"example","type":"example","subtotalRangeBegin":"example","subtotalRangeEnd":"example","membership":{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}}]
_cnd[limit]
array
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array
Sets sorting order field
default Success <XLite\Module\CDev\VolumeDiscounts\Model\VolumeDiscount>[] array
Sample response
[{"id":61,"value":"example","type":"example","subtotalRangeBegin":"example","subtotalRangeEnd":"example","membership":{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}}]
GET
Retrieve volume discount by id
id
integer Required
Id value of the VolumeDiscount object
default Success <XLite\Module\CDev\VolumeDiscounts\Model\VolumeDiscount>
Sample response
{"id":61,"value":"example","type":"example","subtotalRangeBegin":"example","subtotalRangeEnd":"example","membership":{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}}
id
integer
Discount unique ID
value
string
Value
type
string
Type
subtotalRangeBegin
string
Subtotal range (begin)
subtotalRangeEnd
string
Subtotal range (end)
membership
id
integer Required
Id value of the VolumeDiscount object
default Success <XLite\Module\CDev\VolumeDiscounts\Model\VolumeDiscount>
Sample response
{"id":61,"value":"example","type":"example","subtotalRangeBegin":"example","subtotalRangeEnd":"example","membership":{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}}
id
integer
Discount unique ID
value
string
Value
type
string
Type
subtotalRangeBegin
string
Subtotal range (begin)
subtotalRangeEnd
string
Subtotal range (end)
membership
PUT
Update volume discount by id
id
integer Required
Id value of the VolumeDiscount object
<XLite\Module\CDev\VolumeDiscounts\Model\VolumeDiscount>
id
integer
Discount unique ID
value
string
Value
type
string
Type
subtotalRangeBegin
string
Subtotal range (begin)
subtotalRangeEnd
string
Subtotal range (end)
membership
default Success <XLite\Module\CDev\VolumeDiscounts\Model\VolumeDiscount>
Sample response
{"id":61,"value":"example","type":"example","subtotalRangeBegin":"example","subtotalRangeEnd":"example","membership":{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}}
id
integer
Discount unique ID
value
string
Value
type
string
Type
subtotalRangeBegin
string
Subtotal range (begin)
subtotalRangeEnd
string
Subtotal range (end)
membership
id
integer Required
Id value of the VolumeDiscount object
<XLite\Module\CDev\VolumeDiscounts\Model\VolumeDiscount>
id
integer
Discount unique ID
value
string
Value
type
string
Type
subtotalRangeBegin
string
Subtotal range (begin)
subtotalRangeEnd
string
Subtotal range (end)
membership
default Success <XLite\Module\CDev\VolumeDiscounts\Model\VolumeDiscount>
Sample response
{"id":61,"value":"example","type":"example","subtotalRangeBegin":"example","subtotalRangeEnd":"example","membership":{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}}
id
integer
Discount unique ID
value
string
Value
type
string
Type
subtotalRangeBegin
string
Subtotal range (begin)
subtotalRangeEnd
string
Subtotal range (end)
membership
DELETE
Delete volume discount by id
id
integer Required
Id value of the VolumeDiscount object
default Success <XLite\Module\CDev\VolumeDiscounts\Model\VolumeDiscount>
Sample response
{"id":61,"value":"example","type":"example","subtotalRangeBegin":"example","subtotalRangeEnd":"example","membership":{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}}
id
integer
Discount unique ID
value
string
Value
type
string
Type
subtotalRangeBegin
string
Subtotal range (begin)
subtotalRangeEnd
string
Subtotal range (end)
membership
id
integer Required
Id value of the VolumeDiscount object
default Success <XLite\Module\CDev\VolumeDiscounts\Model\VolumeDiscount>
Sample response
{"id":61,"value":"example","type":"example","subtotalRangeBegin":"example","subtotalRangeEnd":"example","membership":{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}}
id
integer
Discount unique ID
value
string
Value
type
string
Type
subtotalRangeBegin
string
Subtotal range (begin)
subtotalRangeEnd
string
Subtotal range (end)
membership
POST
Add volume discount
<XLite\Module\CDev\VolumeDiscounts\Model\VolumeDiscount>
id
integer
Discount unique ID
value
string
Value
type
string
Type
subtotalRangeBegin
string
Subtotal range (begin)
subtotalRangeEnd
string
Subtotal range (end)
membership
default Success <XLite\Module\CDev\VolumeDiscounts\Model\VolumeDiscount>
Sample response
{"id":61,"value":"example","type":"example","subtotalRangeBegin":"example","subtotalRangeEnd":"example","membership":{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}}
id
integer
Discount unique ID
value
string
Value
type
string
Type
subtotalRangeBegin
string
Subtotal range (begin)
subtotalRangeEnd
string
Subtotal range (end)
membership
<XLite\Module\CDev\VolumeDiscounts\Model\VolumeDiscount>
id
integer
Discount unique ID
value
string
Value
type
string
Type
subtotalRangeBegin
string
Subtotal range (begin)
subtotalRangeEnd
string
Subtotal range (end)
membership
default Success <XLite\Module\CDev\VolumeDiscounts\Model\VolumeDiscount>
Sample response
{"id":61,"value":"example","type":"example","subtotalRangeBegin":"example","subtotalRangeEnd":"example","membership":{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"}}
id
integer
Discount unique ID
value
string
Value
type
string
Type
subtotalRangeBegin
string
Subtotal range (begin)
subtotalRangeEnd
string
Subtotal range (end)
membership