Create subscription discounts

Create subscription discounts

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Details of discount to be created

categories

string[]

Product categories

channel

enum<string>

Channel

Available options:

WEBSITE,

POS

customerSegment

string[]

Customer segments

discount

object

Discount detail

Show child attributes

discount.amount

number

Discount amount

frequency

object

Shipping frequency details

Show child attributes

frequency.billingFrequency

integer

Billing frequency

frequency.billingFrequencyType

enum<string>

Billing frequency period

Available options:

daily,

weekly,

monthly,

yearly

frequency.shippingFrequency

integer

Shipping frequency

frequency.shippingFrequencyType

enum<string>

Shipping frequency period

Available options:

daily,

weekly,

monthly,

yearly

itemQuantity

integer

Number of items

message

string

Merchant discount message

skus

string[]

SKUs to which discount applies

target

enum<string>

Discount target

Available options:

PDP,

CART,

QUICK VIEW,

SUBSCRIPTION MANAGEMENT PORTAL

validity

object

Dates during which discount is valid, and orders to which discount applies

Show child attributes

validity.applyOnOrders

integer[]

Orders to which discount applies

validity.endDate

string

Validity end date

validity.startDate

string

Validity start date

Response

200 - application/json

Discount details after creation

data

object

Discount details

Show child attributes

data.categories

string[]

Product categories

data.channel

enum<string>

Channel

Available options:

WEBSITE,

POS

data.createdAt

string

Time customer was created

data.customerSegment

string[]

Customer segments

data.DeletedAt

string

If isDeleted=true, time at which the customer was deleted<br />If isDeleted=false, NULL

data.discount

object

Discount detail

Show child attributes

data.discount.amount

number

Discount amount

data.frequency

object

Shipping frequency details

Show child attributes

data.frequency.billingFrequency

integer

Billing frequency

data.frequency.billingFrequencyType

enum<string>

Billing frequency period

Available options:

daily,

weekly,

monthly,

yearly

data.frequency.shippingFrequency

integer

Shipping frequency

data.frequency.shippingFrequencyType

enum<string>

Shipping frequency period

Available options:

daily,

weekly,

monthly,

yearly

data.id

string

Discount ID

data.isDeleted

boolean

true: Customer is deleted<br />false: Customer is not deleted

data.itemQuantity

integer

Number of items

data.message

string

Merchant discount message

data.offerCode

string

Offer code

data.skus

string[]

SKUs

data.status

enum<string>

Discount status

Available options:

ACTIVE,

INACTIVE

data.target

enum<string>

Discount target

Available options:

PDP,

CART,

QUICK VIEW,

SUBSCRIPTION MANAGEMENT PORTAL

data.updatedAt

string

Most recent time customer was updated

data.validity

object

Dates during which discount is valid, and orders to which discount applies

Show child attributes

data.validity.applyOnOrders

integer[]

Orders to which discount applies

data.validity.endDate

string

Validity end date

data.validity.startDate

string

Validity start date

message

string

Full response message

responseStatus

string

Brief response status