Skip to main content
API docs by Redocly

Discounts (1.0)

Download OpenAPI specification:Download

License: Nexway License Version 1.0

Api to manage discounts

Discount

Get items

Authorizations:
Bearer
query Parameters
required
object (Pageable)
predicate
required
object
target
string

Return selected fields only (multiple occurrences allowed for selecting multiple fields)

customerId
string

Customer Id

storeIds
string

Stores discount can be applied to

productIds
string

Products to which discount is restricted

parentProductIds
string

Products to which discount is restricted

name
string

Name of discount

startDate
string

Discount start date

endDate
string

Discount end date

level
string
Enum: "PRODUCT" "FORCED_CROSS_SELL" "CROSS_SELL" "UP_SELL" "CART"

Level of product discount applies

model
string
Enum: "CAMPAIGN" "COUPON" "PAYMENT_METHOD" "SINGLE_USE_CODE" "SUBSCRIPTION_PLAN"

Model type of discount

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Create an item

Authorizations:
Bearer
Request Body schema: application/json
required
object

Discount amount by currencies

applyOnNetPrice
boolean
Default: "false"

Apply discount on net price instead gross

businessSegment
string
Enum: "B2B" "B2C" "STRICT_B2B" "STRICT_B2C"
buyerBehaviorTriggers
Array of strings unique
Items Enum: "RETAIN_BUYER" "ABANDONED_CART" "RENEWAL"
catalogId
string

Catalog Id

code
string
countries
Array of strings unique
createDate
string <date-time>
Deprecated
cumulative
boolean
currencies
Array of strings unique
customerId
string
dbVersion
integer <int64>
discountRate
number <double> [ 0 .. 1 ]

Value of discount rate

object

Dynamic variables

endDate
required
string <date-time>

Discount end date timestamp in milliseconds

endUserEmails
Array of strings unique
endUserGroupIds
Array of strings unique
endUserTypes
Array of strings unique

Define list of end user types to which coupon can be applied. BUYER : allows apply coupon in cart / RESELLER : allows apply coupon in reseller portal

endingDate
string
enduserId
string

End User Id

externalContext
string

External context

generated
integer <int64>
hasSubscriptionModel
boolean
id
string
Deprecated
lastUpdateReason
string
level
required
string
Enum: "PRODUCT" "FORCED_CROSS_SELL" "CROSS_SELL" "UP_SELL" "CART"
object
maxUsages
integer <int32>
model
string
modelVersion
string
Deprecated
name
required
string
offerSubSource
string
Enum: "SUSPEND" "RESUME"

It defines which offer sub source that should be used for OFFER source. It is mandatory to use it, if OFFER is the discount source

originalId
string
parentProductIds
Array of strings unique

Parent products IDs to which discount can be applied

productIds
Array of strings unique

Products to which discount can be applied

productOrParentId
string
publisherRefIds
Array of strings unique

Product publisher references to which discount can be applied

source
string
sources
any

Sources to which discount can be applied: PURCHASE, MANUAL_RENEWAL, SUBSCRIPTION, BILLING_PLAN, OFFER

startDate
string <date-time>

Discount start date timestamp in milliseconds

startingDate
string
status
string
Enum: "ENABLED" "DISABLED"
storeIds
Array of strings unique

Stores to which discount can be applied

subscriptionGenerations
Array of integers <int32> unique [ items <int32 > ]

subscription generations where the discount can be applied

subscriptionId
string

Subscription id on which discount can be applied

subscriptionSubSources
Array of strings
Items Enum: "TRIAL_CONVERSION" "RENEWAL"

Subscription sub sources on which the discount can be applied: CLASSIC, TRIAL_CONVERSION, RENEWAL

testOrder
boolean
Default: "false"

To show if the order is test

object
updateDate
string <date-time>
Deprecated
used
integer <int64>
maxUsePerEndUser
integer <int32> >= 1
maxUsePerStore
integer <int32> >= 1
weight
integer <int32>

Determines which coupon is applied when there are two with the same name. Higher value increases priority.

Responses

Request samples

Content type
application/json
Example
{
  • "amountByCurrency": {
    },
  • "applyOnNetPrice": "false",
  • "businessSegment": "B2B",
  • "buyerBehaviorTriggers": [
    ],
  • "catalogId": "string",
  • "code": "string",
  • "countries": [
    ],
  • "createDate": "2019-08-24T14:15:22Z",
  • "cumulative": true,
  • "currencies": [
    ],
  • "customerId": "string",
  • "dbVersion": 0,
  • "discountRate": 1,
  • "dynamicVariables": {
    },
  • "endDate": "2019-08-24T14:15:22Z",
  • "endUserEmails": [
    ],
  • "endUserGroupIds": [
    ],
  • "endUserTypes": [
    ],
  • "endingDate": "string",
  • "enduserId": "string",
  • "externalContext": "string",
  • "generated": 0,
  • "hasSubscriptionModel": true,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "level": "PRODUCT",
  • "localizedLabels": {
    },
  • "maxUsages": 0,
  • "model": "CAMPAIGN",
  • "modelVersion": "string",
  • "name": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "originalId": "string",
  • "parentProductIds": [
    ],
  • "productIds": [
    ],
  • "productOrParentId": "string",
  • "publisherRefIds": [
    ],
  • "source": "string",
  • "sources": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "startingDate": "string",
  • "status": "ENABLED",
  • "storeIds": [
    ],
  • "subscriptionGenerations": [
    ],
  • "subscriptionId": "string",
  • "subscriptionSubSources": [
    ],
  • "testOrder": "false",
  • "thresholds": {
    },
  • "updateDate": "2019-08-24T14:15:22Z",
  • "used": 0,
  • "codes": {
    },
  • "maxUsePerEndUser": 1,
  • "maxUsePerStore": 1,
  • "weight": 100
}

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "error": "string",
  • "message": "string",
  • "status": 0,
  • "timestamp": 0
}

getAvailablePaymentMethodDiscounts

Find available payment method discounts for cart

Authorizations:
Bearer
Request Body schema: application/json
required
Array of objects (PaymentMethodDiscount) unique
object (BuyerBehavior)
catalogId
string
object
customerId
string
discountOfferId
string
discounts
Array of strings
Array of objects (DiscountStatus)
object (EndUser)
id
string
locale
string
offerSubSource
string
Enum: "SUSPEND" "RESUME"
paymentMethod
string
paymentMethodDiscountId
string
Array of objects (PaymentType) unique
object (Price)
Array of objects (Product)
source
string
Enum: "PURCHASE" "SUBSCRIPTION" "MANUAL_RENEWAL" "BILLING_PLAN" "OFFER" "MID_TERM_UPGRADE" "UPGRADE"
storeId
string
subscriptionGeneration
integer <int32>
subscriptionId
string
subscriptionSubSource
string
Enum: "TRIAL_CONVERSION" "RENEWAL"
totalAmount
number <double>
Array of objects (Voucher) unique
vouchersTotalAmount
number <double>

Responses

Request samples

Content type
application/json
{
  • "availablePaymentMethodDiscounts": [
    ],
  • "buyerBehavior": {
    },
  • "catalogId": "string",
  • "currency": {
    },
  • "customerId": "string",
  • "discountOfferId": "string",
  • "discounts": [
    ],
  • "discountsStatus": [
    ],
  • "endUser": {
    },
  • "id": "string",
  • "locale": "string",
  • "offerSubSource": "SUSPEND",
  • "paymentMethod": "string",
  • "paymentMethodDiscountId": "string",
  • "paymentTypes": [
    ],
  • "price": {
    },
  • "products": [
    ],
  • "source": "PURCHASE",
  • "storeId": "string",
  • "subscriptionGeneration": 0,
  • "subscriptionId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION",
  • "totalAmount": 0.1,
  • "vouchers": [
    ],
  • "vouchersTotalAmount": 0.1
}

Response samples

Content type
application/json
[
  • {
    }
]

applyDiscountsOnCart

Apply discounts on cart

Authorizations:
Bearer
query Parameters
roundedPrice
boolean
Default: true
Request Body schema: application/json
required
Array of objects (PaymentMethodDiscount) unique
object (BuyerBehavior)
catalogId
string
object
customerId
string
discountOfferId
string
discounts
Array of strings
Array of objects (DiscountStatus)
object (EndUser)
id
string
locale
string
offerSubSource
string
Enum: "SUSPEND" "RESUME"
paymentMethod
string
paymentMethodDiscountId
string
Array of objects (PaymentType) unique
object (Price)
Array of objects (Product)
source
string
Enum: "PURCHASE" "SUBSCRIPTION" "MANUAL_RENEWAL" "BILLING_PLAN" "OFFER" "MID_TERM_UPGRADE" "UPGRADE"
storeId
string
subscriptionGeneration
integer <int32>
subscriptionId
string
subscriptionSubSource
string
Enum: "TRIAL_CONVERSION" "RENEWAL"
totalAmount
number <double>
Array of objects (Voucher) unique
vouchersTotalAmount
number <double>

Responses

Request samples

Content type
application/json
{
  • "availablePaymentMethodDiscounts": [
    ],
  • "buyerBehavior": {
    },
  • "catalogId": "string",
  • "currency": {
    },
  • "customerId": "string",
  • "discountOfferId": "string",
  • "discounts": [
    ],
  • "discountsStatus": [
    ],
  • "endUser": {
    },
  • "id": "string",
  • "locale": "string",
  • "offerSubSource": "SUSPEND",
  • "paymentMethod": "string",
  • "paymentMethodDiscountId": "string",
  • "paymentTypes": [
    ],
  • "price": {
    },
  • "products": [
    ],
  • "source": "PURCHASE",
  • "storeId": "string",
  • "subscriptionGeneration": 0,
  • "subscriptionId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION",
  • "totalAmount": 0.1,
  • "vouchers": [
    ],
  • "vouchersTotalAmount": 0.1
}

Response samples

Content type
application/json
{
  • "availablePaymentMethodDiscounts": [
    ],
  • "buyerBehavior": {
    },
  • "catalogId": "string",
  • "currency": {
    },
  • "customerId": "string",
  • "discountOfferId": "string",
  • "discounts": [
    ],
  • "discountsStatus": [
    ],
  • "endUser": {
    },
  • "id": "string",
  • "locale": "string",
  • "offerSubSource": "SUSPEND",
  • "paymentMethod": "string",
  • "paymentMethodDiscountId": "string",
  • "paymentTypes": [
    ],
  • "price": {
    },
  • "products": [
    ],
  • "source": "PURCHASE",
  • "storeId": "string",
  • "subscriptionGeneration": 0,
  • "subscriptionId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION",
  • "totalAmount": 0.1,
  • "vouchers": [
    ],
  • "vouchersTotalAmount": 0.1
}

applyDiscountsOnCart

Apply discounts on cart

Authorizations:
Bearer
Request Body schema: application/json
required
Array of objects (PaymentMethodDiscount) unique
object (BuyerBehavior)
catalogId
string
object
customerId
string
discountOfferId
string
discounts
Array of strings
Array of objects (DiscountStatus)
object (EndUser)
id
string
locale
string
offerSubSource
string
Enum: "SUSPEND" "RESUME"
paymentMethod
string
paymentMethodDiscountId
string
Array of objects (PaymentType) unique
object (Price)
Array of objects (Product)
source
string
Enum: "PURCHASE" "SUBSCRIPTION" "MANUAL_RENEWAL" "BILLING_PLAN" "OFFER" "MID_TERM_UPGRADE" "UPGRADE"
storeId
string
subscriptionGeneration
integer <int32>
subscriptionId
string
subscriptionSubSource
string
Enum: "TRIAL_CONVERSION" "RENEWAL"
totalAmount
number <double>
Array of objects (Voucher) unique
vouchersTotalAmount
number <double>

Responses

Request samples

Content type
application/json
{
  • "availablePaymentMethodDiscounts": [
    ],
  • "buyerBehavior": {
    },
  • "catalogId": "string",
  • "currency": {
    },
  • "customerId": "string",
  • "discountOfferId": "string",
  • "discounts": [
    ],
  • "discountsStatus": [
    ],
  • "endUser": {
    },
  • "id": "string",
  • "locale": "string",
  • "offerSubSource": "SUSPEND",
  • "paymentMethod": "string",
  • "paymentMethodDiscountId": "string",
  • "paymentTypes": [
    ],
  • "price": {
    },
  • "products": [
    ],
  • "source": "PURCHASE",
  • "storeId": "string",
  • "subscriptionGeneration": 0,
  • "subscriptionId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION",
  • "totalAmount": 0.1,
  • "vouchers": [
    ],
  • "vouchersTotalAmount": 0.1
}

Response samples

Content type
application/json
{
  • "availablePaymentMethodDiscounts": [
    ],
  • "buyerBehavior": {
    },
  • "catalogId": "string",
  • "currency": {
    },
  • "customerId": "string",
  • "discountOfferId": "string",
  • "discounts": [
    ],
  • "discountsStatus": [
    ],
  • "endUser": {
    },
  • "id": "string",
  • "locale": "string",
  • "offerSubSource": "SUSPEND",
  • "paymentMethod": "string",
  • "paymentMethodDiscountId": "string",
  • "paymentTypes": [
    ],
  • "price": {
    },
  • "products": [
    ],
  • "source": "PURCHASE",
  • "storeId": "string",
  • "subscriptionGeneration": 0,
  • "subscriptionId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION",
  • "totalAmount": 0.1,
  • "vouchers": [
    ],
  • "vouchersTotalAmount": 0.1
}

Get distinct values for a given field

Authorizations:
Bearer
query Parameters
target
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

importDiscount

Import a discount

Authorizations:
Bearer
query Parameters
storeId
string
reason
string
Default: "resource import thru REST Api"
Request Body schema: application/json
required
object

Discount amount by currencies

applyOnNetPrice
boolean
Default: "false"

Apply discount on net price instead gross

businessSegment
string
Enum: "B2B" "B2C" "STRICT_B2B" "STRICT_B2C"
buyerBehaviorTriggers
Array of strings unique
Items Enum: "RETAIN_BUYER" "ABANDONED_CART" "RENEWAL"
catalogId
string

Catalog Id

code
string
countries
Array of strings unique
createDate
string <date-time>
Deprecated
cumulative
boolean
currencies
Array of strings unique
customerId
string
dbVersion
integer <int64>
discountRate
number <double> [ 0 .. 1 ]

Value of discount rate

object

Dynamic variables

endDate
required
string <date-time>

Discount end date timestamp in milliseconds

endUserEmails
Array of strings unique
endUserGroupIds
Array of strings unique
endUserTypes
Array of strings unique

Define list of end user types to which coupon can be applied. BUYER : allows apply coupon in cart / RESELLER : allows apply coupon in reseller portal

endingDate
string
enduserId
string

End User Id

externalContext
string

External context

generated
integer <int64>
hasSubscriptionModel
boolean
id
string
Deprecated
lastUpdateReason
string
level
required
string
Enum: "PRODUCT" "FORCED_CROSS_SELL" "CROSS_SELL" "UP_SELL" "CART"
object
maxUsages
integer <int32>
model
string
modelVersion
string
Deprecated
name
required
string
offerSubSource
string
Enum: "SUSPEND" "RESUME"

It defines which offer sub source that should be used for OFFER source. It is mandatory to use it, if OFFER is the discount source

originalId
string
parentProductIds
Array of strings unique

Parent products IDs to which discount can be applied

productIds
Array of strings unique

Products to which discount can be applied

productOrParentId
string
publisherRefIds
Array of strings unique

Product publisher references to which discount can be applied

source
string
sources
any

Sources to which discount can be applied: PURCHASE, MANUAL_RENEWAL, SUBSCRIPTION, BILLING_PLAN, OFFER

startDate
string <date-time>

Discount start date timestamp in milliseconds

startingDate
string
status
string
Enum: "ENABLED" "DISABLED"
storeIds
Array of strings unique

Stores to which discount can be applied

subscriptionGenerations
Array of integers <int32> unique [ items <int32 > ]

subscription generations where the discount can be applied

subscriptionId
string

Subscription id on which discount can be applied

subscriptionSubSources
Array of strings
Items Enum: "TRIAL_CONVERSION" "RENEWAL"

Subscription sub sources on which the discount can be applied: CLASSIC, TRIAL_CONVERSION, RENEWAL

testOrder
boolean
Default: "false"

To show if the order is test

object
updateDate
string <date-time>
Deprecated
used
integer <int64>
maxUsePerEndUser
integer <int32> >= 1
maxUsePerStore
integer <int32> >= 1
weight
integer <int32>

Determines which coupon is applied when there are two with the same name. Higher value increases priority.

Responses

Request samples

Content type
application/json
Example
{
  • "amountByCurrency": {
    },
  • "applyOnNetPrice": "false",
  • "businessSegment": "B2B",
  • "buyerBehaviorTriggers": [
    ],
  • "catalogId": "string",
  • "code": "string",
  • "countries": [
    ],
  • "createDate": "2019-08-24T14:15:22Z",
  • "cumulative": true,
  • "currencies": [
    ],
  • "customerId": "string",
  • "dbVersion": 0,
  • "discountRate": 1,
  • "dynamicVariables": {
    },
  • "endDate": "2019-08-24T14:15:22Z",
  • "endUserEmails": [
    ],
  • "endUserGroupIds": [
    ],
  • "endUserTypes": [
    ],
  • "endingDate": "string",
  • "enduserId": "string",
  • "externalContext": "string",
  • "generated": 0,
  • "hasSubscriptionModel": true,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "level": "PRODUCT",
  • "localizedLabels": {
    },
  • "maxUsages": 0,
  • "model": "CAMPAIGN",
  • "modelVersion": "string",
  • "name": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "originalId": "string",
  • "parentProductIds": [
    ],
  • "productIds": [
    ],
  • "productOrParentId": "string",
  • "publisherRefIds": [
    ],
  • "source": "string",
  • "sources": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "startingDate": "string",
  • "status": "ENABLED",
  • "storeIds": [
    ],
  • "subscriptionGenerations": [
    ],
  • "subscriptionId": "string",
  • "subscriptionSubSources": [
    ],
  • "testOrder": "false",
  • "thresholds": {
    },
  • "updateDate": "2019-08-24T14:15:22Z",
  • "used": 0,
  • "codes": {
    },
  • "maxUsePerEndUser": 1,
  • "maxUsePerStore": 1,
  • "weight": 100
}

Response samples

Content type
application/json
Example
{
  • "amountByCurrency": {
    },
  • "applyOnNetPrice": "false",
  • "businessSegment": "B2B",
  • "buyerBehaviorTriggers": [
    ],
  • "catalogId": "string",
  • "countries": [
    ],
  • "createDate": "2019-08-24T14:15:22Z",
  • "cumulative": true,
  • "currencies": [
    ],
  • "customerId": "string",
  • "dbVersion": 0,
  • "discountRate": 1,
  • "dynamicVariables": {
    },
  • "endDate": "2019-08-24T14:15:22Z",
  • "endUserEmails": [
    ],
  • "endUserGroupIds": [
    ],
  • "endUserTypes": [
    ],
  • "enduserId": "string",
  • "externalContext": "string",
  • "generated": 0,
  • "hasSubscriptionModel": true,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "level": "PRODUCT",
  • "localizedLabels": {
    },
  • "maxUsages": 0,
  • "model": "CAMPAIGN",
  • "modelVersion": "string",
  • "name": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "parentProductIds": [
    ],
  • "productIds": [
    ],
  • "publisherRefIds": [
    ],
  • "sources": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "ENABLED",
  • "storeIds": [
    ],
  • "subscriptionGenerations": [
    ],
  • "subscriptionId": "string",
  • "subscriptionSubSources": [
    ],
  • "testOrder": "false",
  • "thresholds": {
    },
  • "updateDate": "2019-08-24T14:15:22Z",
  • "used": 0,
  • "codes": {
    },
  • "maxUsePerEndUser": 1,
  • "maxUsePerStore": 1,
  • "weight": 100
}

Get recap quantities for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Search unwind for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

declareUsages

Declare discount usages

Authorizations:
Bearer
query Parameters
reason
string
Default: "notify usage of single codes thru REST Api"
Request Body schema: application/json
required
Array
catalogId
string

Catalog Id

customerId
required
string

Customer Id discount applied to

discountCode
string

Discount Code

discountId
required
string

Discount Id

endUserEmail
required
string

Email used

endUserId
string

EndUser Id

orderId
required
string

Order Id discount applied to

storeId
required
string

Store Id discount applied to

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Delete item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "amountByCurrency": {
    },
  • "applyOnNetPrice": "false",
  • "businessSegment": "B2B",
  • "buyerBehaviorTriggers": [
    ],
  • "catalogId": "string",
  • "countries": [
    ],
  • "createDate": "2019-08-24T14:15:22Z",
  • "cumulative": true,
  • "currencies": [
    ],
  • "customerId": "string",
  • "dbVersion": 0,
  • "discountRate": 1,
  • "dynamicVariables": {
    },
  • "endDate": "2019-08-24T14:15:22Z",
  • "endUserEmails": [
    ],
  • "endUserGroupIds": [
    ],
  • "endUserTypes": [
    ],
  • "enduserId": "string",
  • "externalContext": "string",
  • "generated": 0,
  • "hasSubscriptionModel": true,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "level": "PRODUCT",
  • "localizedLabels": {
    },
  • "maxUsages": 0,
  • "model": "CAMPAIGN",
  • "modelVersion": "string",
  • "name": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "parentProductIds": [
    ],
  • "productIds": [
    ],
  • "publisherRefIds": [
    ],
  • "sources": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "ENABLED",
  • "storeIds": [
    ],
  • "subscriptionGenerations": [
    ],
  • "subscriptionId": "string",
  • "subscriptionSubSources": [
    ],
  • "testOrder": "false",
  • "thresholds": {
    },
  • "updateDate": "2019-08-24T14:15:22Z",
  • "used": 0,
  • "codes": {
    },
  • "maxUsePerEndUser": 1,
  • "maxUsePerStore": 1,
  • "weight": 100
}

Update item

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema: application/json
required
object

Discount amount by currencies

applyOnNetPrice
boolean
Default: "false"

Apply discount on net price instead gross

businessSegment
string
Enum: "B2B" "B2C" "STRICT_B2B" "STRICT_B2C"
buyerBehaviorTriggers
Array of strings unique
Items Enum: "RETAIN_BUYER" "ABANDONED_CART" "RENEWAL"
catalogId
string

Catalog Id

code
string
countries
Array of strings unique
createDate
string <date-time>
Deprecated
cumulative
boolean
currencies
Array of strings unique
customerId
string
dbVersion
integer <int64>
discountRate
number <double> [ 0 .. 1 ]

Value of discount rate

object

Dynamic variables

endDate
required
string <date-time>

Discount end date timestamp in milliseconds

endUserEmails
Array of strings unique
endUserGroupIds
Array of strings unique
endUserTypes
Array of strings unique

Define list of end user types to which coupon can be applied. BUYER : allows apply coupon in cart / RESELLER : allows apply coupon in reseller portal

endingDate
string
enduserId
string

End User Id

externalContext
string

External context

generated
integer <int64>
hasSubscriptionModel
boolean
id
string
Deprecated
lastUpdateReason
string
level
required
string
Enum: "PRODUCT" "FORCED_CROSS_SELL" "CROSS_SELL" "UP_SELL" "CART"
object
maxUsages
integer <int32>
model
string
modelVersion
string
Deprecated
name
required
string
offerSubSource
string
Enum: "SUSPEND" "RESUME"

It defines which offer sub source that should be used for OFFER source. It is mandatory to use it, if OFFER is the discount source

originalId
string
parentProductIds
Array of strings unique

Parent products IDs to which discount can be applied

productIds
Array of strings unique

Products to which discount can be applied

productOrParentId
string
publisherRefIds
Array of strings unique

Product publisher references to which discount can be applied

source
string
sources
any

Sources to which discount can be applied: PURCHASE, MANUAL_RENEWAL, SUBSCRIPTION, BILLING_PLAN, OFFER

startDate
string <date-time>

Discount start date timestamp in milliseconds

startingDate
string
status
string
Enum: "ENABLED" "DISABLED"
storeIds
Array of strings unique

Stores to which discount can be applied

subscriptionGenerations
Array of integers <int32> unique [ items <int32 > ]

subscription generations where the discount can be applied

subscriptionId
string

Subscription id on which discount can be applied

subscriptionSubSources
Array of strings
Items Enum: "TRIAL_CONVERSION" "RENEWAL"

Subscription sub sources on which the discount can be applied: CLASSIC, TRIAL_CONVERSION, RENEWAL

testOrder
boolean
Default: "false"

To show if the order is test

object
updateDate
string <date-time>
Deprecated
used
integer <int64>
maxUsePerEndUser
integer <int32> >= 1
maxUsePerStore
integer <int32> >= 1
weight
integer <int32>

Determines which coupon is applied when there are two with the same name. Higher value increases priority.

Responses

Request samples

Content type
application/json
Example
{
  • "amountByCurrency": {
    },
  • "applyOnNetPrice": "false",
  • "businessSegment": "B2B",
  • "buyerBehaviorTriggers": [
    ],
  • "catalogId": "string",
  • "code": "string",
  • "countries": [
    ],
  • "createDate": "2019-08-24T14:15:22Z",
  • "cumulative": true,
  • "currencies": [
    ],
  • "customerId": "string",
  • "dbVersion": 0,
  • "discountRate": 1,
  • "dynamicVariables": {
    },
  • "endDate": "2019-08-24T14:15:22Z",
  • "endUserEmails": [
    ],
  • "endUserGroupIds": [
    ],
  • "endUserTypes": [
    ],
  • "endingDate": "string",
  • "enduserId": "string",
  • "externalContext": "string",
  • "generated": 0,
  • "hasSubscriptionModel": true,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "level": "PRODUCT",
  • "localizedLabels": {
    },
  • "maxUsages": 0,
  • "model": "CAMPAIGN",
  • "modelVersion": "string",
  • "name": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "originalId": "string",
  • "parentProductIds": [
    ],
  • "productIds": [
    ],
  • "productOrParentId": "string",
  • "publisherRefIds": [
    ],
  • "source": "string",
  • "sources": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "startingDate": "string",
  • "status": "ENABLED",
  • "storeIds": [
    ],
  • "subscriptionGenerations": [
    ],
  • "subscriptionId": "string",
  • "subscriptionSubSources": [
    ],
  • "testOrder": "false",
  • "thresholds": {
    },
  • "updateDate": "2019-08-24T14:15:22Z",
  • "used": 0,
  • "codes": {
    },
  • "maxUsePerEndUser": 1,
  • "maxUsePerStore": 1,
  • "weight": 100
}

Response samples

Content type
application/json
Example
{
  • "amountByCurrency": {
    },
  • "applyOnNetPrice": "false",
  • "businessSegment": "B2B",
  • "buyerBehaviorTriggers": [
    ],
  • "catalogId": "string",
  • "countries": [
    ],
  • "createDate": "2019-08-24T14:15:22Z",
  • "cumulative": true,
  • "currencies": [
    ],
  • "customerId": "string",
  • "dbVersion": 0,
  • "discountRate": 1,
  • "dynamicVariables": {
    },
  • "endDate": "2019-08-24T14:15:22Z",
  • "endUserEmails": [
    ],
  • "endUserGroupIds": [
    ],
  • "endUserTypes": [
    ],
  • "enduserId": "string",
  • "externalContext": "string",
  • "generated": 0,
  • "hasSubscriptionModel": true,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "level": "PRODUCT",
  • "localizedLabels": {
    },
  • "maxUsages": 0,
  • "model": "CAMPAIGN",
  • "modelVersion": "string",
  • "name": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "parentProductIds": [
    ],
  • "productIds": [
    ],
  • "publisherRefIds": [
    ],
  • "sources": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "ENABLED",
  • "storeIds": [
    ],
  • "subscriptionGenerations": [
    ],
  • "subscriptionId": "string",
  • "subscriptionSubSources": [
    ],
  • "testOrder": "false",
  • "thresholds": {
    },
  • "updateDate": "2019-08-24T14:15:22Z",
  • "used": 0,
  • "codes": {
    },
  • "maxUsePerEndUser": 1,
  • "maxUsePerStore": 1,
  • "weight": 100
}

generateSingleUseCodes

Generate coupons

Authorizations:
Bearer
path Parameters
id
required
string

Discount id

query Parameters
dryRun
boolean
reason
string
Default: "generation request of single codes thru REST Api"
Request Body schema: application/json
required
forceLowercase
boolean
forceUppercase
boolean
prefix
string [ 0 .. 8 ] characters
quantity
integer <int32> [ 1 .. 750 ]
size
integer <int32> [ 8 .. 32 ]

Responses

Request samples

Content type
application/json
{
  • "forceLowercase": true,
  • "forceUppercase": true,
  • "prefix": "string",
  • "quantity": 1,
  • "size": 8
}

Response samples

Content type
application/json
{
  • "codes": [
    ],
  • "remaining": 0
}

Price beautifier configuration

Get items

Authorizations:
Bearer
query Parameters
required
object (Pageable)
predicate
required
object
target
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Create an item

Authorizations:
Bearer
Request Body schema: application/json
required
createDate
string <date-time>
Deprecated
dbVersion
integer <int64>
id
string
Deprecated
lastUpdateReason
string
modelVersion
string
Deprecated
originalId
string
object
storeId
string
updateDate
string <date-time>
Deprecated

Responses

Request samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "originalId": "string",
  • "rules": {
    },
  • "storeId": "string",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "error": "string",
  • "message": "string",
  • "status": 0,
  • "timestamp": 0
}

Get distinct values for a given field

Authorizations:
Bearer
query Parameters
target
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Get recap quantities for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Search unwind for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Delete item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "rules": {
    },
  • "storeId": "string",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Update item

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema: application/json
required
createDate
string <date-time>
Deprecated
dbVersion
integer <int64>
id
string
Deprecated
lastUpdateReason
string
modelVersion
string
Deprecated
originalId
string
object
storeId
string
updateDate
string <date-time>
Deprecated

Responses

Request samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "originalId": "string",
  • "rules": {
    },
  • "storeId": "string",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "rules": {
    },
  • "storeId": "string",
  • "updateDate": "2019-08-24T14:15:22Z"
}

DiscountUsage

Get items

Authorizations:
Bearer
query Parameters
required
object (Pageable)
predicate
required
object
target
string

Return selected fields only (multiple occurrences allowed for selecting multiple fields)

orderId
string

Order Id discount applied to

customerId
string

Customer Id discount applied to

storeId
string

Store Id discount applied to

discountId
string

Discount Id

discountCode
string

Discount Code

endUserEmail
string

Email used

endUserId
string

EndUser Id

catalogId
string

Catalog Id

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Get distinct values for a given field

Authorizations:
Bearer
query Parameters
target
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Get recap quantities for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Search unwind for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "discountCode": "string",
  • "discountId": "string",
  • "endUserEmail": "string",
  • "enduserId": "string",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "orderId": "string",
  • "storeId": "string",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "useDate": "2019-08-24T14:15:22Z",
  • "used": true
}