Skip to main content

Documentation Portal

Discounts

Parameter Name

Type

Description

Mandatory

CouponCode

String

Merchant Coupon Code used for this discount (applicable to coupon-based discounts only).

Max length: 100 chars.

No

Description

String

Discount textual description.

Length: Unlimited.

No

DiscountType

Integer

One of the following possible values of DiscountTypeOptions enumeration denoting a type of discount:

  • Cart discount - 1

  • Shipping discount - 2

  • Loyalty points discount - 3

  • Duties discount - 4

  • Checkout Loyalty points discount - 5

  • Payment charge - 6

No

DiscountValue

Decimal

Discount value in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the Merchant.Order, after applying country coefficient, FX conversion, and IncludeVAT.

No

Name

String

Discount name.

Length: Unlimited.

No

OriginalDiscountValue

Decimal

Discount value in the currency defined in the CurrencyCode; property of the Merchant.Order; object for the order being submitted to the Merchant.

Yes

VATRate

Decimal

The VAT rate applied to this discount

No (Required for merchants whose base country has VAT. If not specified, will default to 0.)

ProductCartItemId

String

For product level discount, match the unique CartItemId line identifier of the respective product in the productList. For cart level discounts, leave this field blank or null.

No

CalculationMode

Integer

The mode of calculation:

  • 1 - value in base currency while maintaining ratio to domestic discount

  • 2 - fixed amount in base currency

  • 3 - fixed amount in shopper currency (used for fixed price markets only)

Yes