UsedCoupon (CDev\Coupons)
UsedCoupon represents the coupon which has already been applied to the specific order.
GET
Retrieve used coupons 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\Coupons\Model\UsedCoupon>[] array
Sample response
[{"id":"integer","code":"string","value":"string","order":"<XLite\\Model\\Order>","coupon":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>"}]
_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\Coupons\Model\UsedCoupon>[] array
Sample response
[{"id":"integer","code":"string","value":"string","order":"<XLite\\Model\\Order>","coupon":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>"}]
GET
Retrieve used coupon by id
id
integer Required
Id value of the UsedCoupon object
default Success <XLite\Module\CDev\Coupons\Model\UsedCoupon>
Sample response
{"id":"integer","code":"string","value":"string","order":"<XLite\\Model\\Order>","coupon":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>"}
id
integer
Product unique ID
code
string
Code
value
string
Value
order
id
integer Required
Id value of the UsedCoupon object
default Success <XLite\Module\CDev\Coupons\Model\UsedCoupon>
Sample response
{"id":"integer","code":"string","value":"string","order":"<XLite\\Model\\Order>","coupon":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>"}
id
integer
Product unique ID
code
string
Code
value
string
Value
order
coupon
type
string
Type
PUT
Update used coupon by id
id
integer Required
Id value of the UsedCoupon object
<XLite\Module\CDev\Coupons\Model\UsedCoupon>
id
integer
Product unique ID
code
string
Code
value
string
Value
order
id
integer Required
Id value of the UsedCoupon object
<XLite\Module\CDev\Coupons\Model\UsedCoupon>
id
integer
Product unique ID
code
string
Code
value
string
Value
order
coupon
type
string
Type
default Success <XLite\Module\CDev\Coupons\Model\UsedCoupon>
Sample response
{"id":"integer","code":"string","value":"string","order":"<XLite\\Model\\Order>","coupon":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>"}
id
integer
Product unique ID
code
string
Code
value
string
Value
order
coupon
type
string
Type
DELETE
Delete used coupon by id
id
integer Required
Id value of the UsedCoupon object
default Success <XLite\Module\CDev\Coupons\Model\UsedCoupon>
Sample response
{"id":"integer","code":"string","value":"string","order":"<XLite\\Model\\Order>","coupon":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>"}
id
integer
Product unique ID
code
string
Code
value
string
Value
order
id
integer Required
Id value of the UsedCoupon object
default Success <XLite\Module\CDev\Coupons\Model\UsedCoupon>
Sample response
{"id":"integer","code":"string","value":"string","order":"<XLite\\Model\\Order>","coupon":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>"}
id
integer
Product unique ID
code
string
Code
value
string
Value
order
coupon
type
string
Type
POST
Add used coupon
<XLite\Module\CDev\Coupons\Model\UsedCoupon>
id
integer
Product unique ID
code
string
Code
value
string
Value
order
<XLite\Module\CDev\Coupons\Model\UsedCoupon>
id
integer
Product unique ID
code
string
Code
value
string
Value
order
coupon
type
string
Type
default Success <XLite\Module\CDev\Coupons\Model\UsedCoupon>
Sample response
{"id":"integer","code":"string","value":"string","order":"<XLite\\Model\\Order>","coupon":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>"}
id
integer
Product unique ID
code
string
Code
value
string
Value
order
coupon
type
string
Type