get

/orders/{order_id}/coupons

Lists all order coupons. Optional parameters can be passed in.

Authorization

apiKey - X-Auth-Token
apiKey - X-Auth-Client

Request Parameters

1 Path Parameter
2 Query Parameters
2 Headers

Responses

2 Examples
Schema
array[object]
id
integer

Numeric ID of the coupon code.

1 validation
coupon_id
integer

Numeric ID of the associated coupon.

1 validation
order_id
integer

Numeric ID of the associated order.

1 validation
code
string

Coupon code, as a string.

1 validation
amount
string

Amount of the discount. This information is returned as in integer. Dollar and percentage discounts will return the same. For example, $3 returns as ‘3’ while 5% will return as 5. Check the discount type to see what type of discount is available. (Float, Float-As-String, Integer)

1 validation
type
string

type 0: per_item_discount type 1: percentage_discount type 2: per_total_discount type 3: shipping_discount type 4: free_shipping

1 validation
discount
number

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)

1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
2 path params not set
store_hash
order_id
$$.env
2 variables not set
X-Auth-Token
X-Auth-Client