Create coupon

POST/v1/coupons

Authorization

bearerAuth

AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

description?null|string

status?PromotionStatus

Value in

"draft"
"active"
"scheduled"
"inactive"

type?PromotionType

Value in

"percentage"
"fixedAmount"
"freeShipping"
"buyXGetY"

target?PromotionTarget

Value in

"order"
"item"
"shipping"

amount?number

Formatdouble

allocation?PromotionAllocation

Value in

"once"
"each"

maxQuantity?|

Formatint32

applyAfterTaxes?boolean

sellerId?null|string

isAutomatic?boolean

validFrom?|

Formatdate-time

validTo?|

Formatdate-time

usageLimit?|

Formatint32

customerUsageLimit?|

Formatint32

combineWithOtherDiscounts?boolean

rules?null|array<>

codes?null|array<string>

codeUsageLimit?|

Formatint32

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/v1/coupons" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Create coupon

Authorization

Request Body

Response Body

201application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

409application/problem+json

500application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`