Create a new coupon pool

post

https://api.staging.antavo.com/v1/coupon-pools

This endpoint can be used to create a new coupon pool with the attributes provided in the request body.

Body Params

The name, source and type attributes are required. The request body can also include custom attributes (if used).

external_id

string

length between 6 and 24

An optional unique identifier used for mapping the coupon pool to an external system.

name

string

required

The name of the coupon pool.

source

string

required

The source of the coupon pool, which must be uploaded.

type

string

required

The type of the coupon pool, which can be amount, percentage, free_shipping or gift_card.

value

float

≥ 0.01

The value of the coupon pool.

minimum_value

number

≥ 1

The minimum value below which gift card coupons are invalidated (only applicable if the value of the type attribute is set to gift_card).

minimum_redemption_value

number

≥ 1

The minimum redemption value for gift card coupons (only applicable if the value of the type attribute is set to gift_card).

currency

string

The currency of the gift card coupons (only applicable if the value of the type attribute is set to gift_card).

purchase_minimum

number

≥ 1

The minimum basket value required to use coupons from this coupon pool.

expiration_time

string

The expiration time of coupons from this coupon pool (e.g., 2 months).

aggregated

boolean

Defaults to false

The value determines whether the same coupon code is assigned each time a coupon from this coupon pool is issued for a specific customer.

products

array of strings

List of active product IDs to which the coupon discount can be applied (only applicable if the Product catalog module is enabled).

products

stores

array of strings

List of active store IDs for which the coupons of this coupon pool can be validated (only applicable if the Stores module is enabled).

stores

Responses

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 OK

400400 Bad Request Exception