Orders V2
List Order Coupons
GET /stores/{store_hash}/v2/orders/{order_id}/coupons
Request
Lists all order coupons. Optional parameters can be passed in.
Type int | Type Name |
|---|---|
0 | per_item_discount |
1 | percentage_discount |
2 | per_total_discount |
3 | shipping_discount |
4 | free_shipping |
5 | promotion |
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- page in query - number
The page to return in the response.
- limit in query - number
Number of results to return.
example
Response
Body
idinteger
Numeric ID of the coupon code.
Example: 3
coupon_idinteger
Numeric ID of the associated coupon.
Example: 1
order_idinteger
Numeric ID of the associated order.
Example: 120
codestring or null
Coupon code, as a string.
Example: S2549JM0Y
amount
Amount of the discount. This information is returned as in integer. Dollar and percentage discounts will return the same. For example, $3 returns as
3while 5% will return as5. Check the discount type to see what type of discount is available.Any of:Type: stringExample: 5
typeinteger
0: per_item_discount 1: percentage_discount 2: per_total_discount 3: shipping_discount 4: free_shipping 5: promotions
Allowed: 0 | 1 | 2 | 3 | 4 | 5
discountnumber
The amount off the order the discount is worth. For example, if an order subtotal is $90 and the discount is $3 then it will return as 3.000. If the discount is 3% then will return as 2.7000 or the amount of the order. (Float, Float-As-String, Integer)
Example: 2.7