Get Discounts

Gets applicable discounts for a transaction. The discounts are categorized as
1) Transaction-level discounts: Applied on the whole transaction. For example, if the transaction is for $100, the discount is applied by percentage or amount to the whole transaction amount. This category includes tier-specific discounts.
2) Item-level discounts: Applied on specific SKU so that discount percentage or amount is applied to specific product (regardless of the quantity).
3) Miscellaneous discounts - This category captures all other types of discounts.

Authorizations

Authorization

string

header

required

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

Body

application/json

profileId

string

required

Profile ID of member

entityReference

string

required

External reference of the store where the transaction occurred

Minimum length: 1

transactionTimestamp

string

required

Transaction timestamp (UTC format)

taxAmount

number

required

Tax amount

grossAmount

number

required

Gross amount of the transaction (before discount)

netAmount

number

required

Net amount of the transaction (after discount).

transactionItems

object[]

Show child attributes

transactionItems.grossAmount

number

required

Transaction gross amount

transactionItems.netAmount

number

required

Net amount of transaction

transactionItems.categories

string[]

required

List of item categories

transactionItems.itemPrice

integer

required

Item price

transactionItems.itemQuantity

integer

required

Item quantity

transactionItems.SKU

string

required

Stock Keeping Unit (SKU) of item

Required string length: 1 - 100

transactionItems.taxAmount

number

Tax amount

transactionItems.itemName

string

Item name

Minimum length: 1

Response

200

application/json

Ok

Response of the Discounts API

status

integer

Status of the call

message

string

default:

Exception message

Message corresponding to the call

errors

object

Error details, if applicable

data

object[]

Show child attributes

data.grossAmount

number

Gross amount of transaction (before discount)

data.taxAmount

number

Tax amount on transaction

data.netAmount

number

Net amount of transaction (after discount).

data.discounts

object[]

Show child attributes

data.discounts.value

number

required

Monetary value of discount

data.discounts.type

string

Discount type

Minimum length: 1

data.discounts.description

string

Description of the discount

Minimum length: 1

data.discounts.id

integer

Discount ID

data.discounts.ruleName

string

Name of the discount-rule

data.discounts.discountPercentage

number

Percentage value of the discount

data.discounts.discountAmount

number

Monetary value of the discount

data.transactionItems

object[]

Show child attributes

data.transactionItems.SKU

string

Stock Keeping Unit (SKU) of item

Minimum length: 1

data.transactionItems.discounts

object[]

Show child attributes

data.transactionItems.discounts.value

number

required

Monetary value of discount

data.transactionItems.discounts.type

string

Discount type

Minimum length: 1

data.transactionItems.discounts.description

string

Description of the discount

Minimum length: 1

data.transactionItems.discounts.id

integer

Discount ID

data.transactionItems.discounts.ruleName

string

Name of the discount-rule

data.transactionItems.discounts.discountPercentage

number

Percentage value of the discount

data.transactionItems.discounts.discountAmount

number

Monetary value of the discount

data.miscellaneous

object[]