Discount

Parameter Name	Type	Description	Mandatory
`CalculationMode`	Decimal	One of the following possible values of `CalculationModeOptions` enumeration denoting the calculation mode of a discount to be implemented by GEM, see the CalculationMode Option Value Table below.	No
`CouponCode`	String	Merchant Coupon Code used for this discount (applicable to coupon-based discounts only)	No
`Description`	String	Discount textual description	No
`DiscountCode`	String	Discount code used to identify the discount on the Merchant’s site. This property may be optionally specified in the `SendCart` method only, so that the same value could be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` method.	No
`DiscountType`	Decimal	One of the following possible enum values of `DiscountTypeOptions` enumeration denoting a type of discount. See the DiscountType Option Table below.
`DiscountValue`	Decimal	Discount value as displayed to the customer, after applying country coefficient, FX conversion and `IncludeVAT` handling.
`LocalVATRate`	Decimal	VAT rate that would be applied to this discount if the order was placed by the local customer. This value must be specified if `UseCountryVAT` for the current Country is TRUE and therefore `VATRate` property denotes the VAT for the target country.	No
`LoyaltyVoucherCode`	String	Code used on the Merchant’s site to identify the Loyalty Voucher that this discount is based on	No
`Name`	String	Discount name
`OriginalDiscountValue`	Decimal	Discount value in original Merchant currency including the local VAT, before applying any price modifications. This property always denotes the discount value in the default Merchant’s country, regardless of `UseCountryVAT` for the end customer’s current country.
`ProductCartItemId`	String	Identifier of the product cart item related to this discount on the Merchant’s site. This property may be optionally specified in the `SendCart` method only so that the same value could be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` method.	No
`VATRate`	Decimal	The VAT rate applied to this discount

DiscountType Options

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

DiscountType Option Value	Name	Description
1	Cart discount	Discount related to volume, amount, coupon or another promotion value.
2	Shipping discount	Discount aimed to sponsor international shipping.
3	Loyalty points discount	Discount applied against the Merchant’s loyalty points to be spent for this purchase.
4	Duties discount	Discount aimed to sponsor taxes & duties pre-paid by the end customer in Global‑e checkout.
5	Checkout Loyalty Points Discount	Discount applied against the Merchant’s loyalty points in Global‑e checkout.
6	Payment Charge	Discount aimed to sponsor “Cash on Delivery” fee.

CalculationMode Options

One of the following possible values of CalculationModeOptions enumeration denoting the calculation mode of a discount to be implemented by GEM:

CalculationMode Option Value	Name	Description
1 (default)	Percentage discount	The discount value specified in `OriginalDiscountValue` should be used to calculate the `DiscountValue` as a percentage of the full product price (specified in `Product.OriginalSalePrice` for line item level discounts) or the cart price (sum of all `Product.OriginalSalePrice` values) for cart level discounts. Note: The discount value provided is not a percentage. It represents the discount amount in your domestic currency. The ratio of the discount amount to the domestic price is calculated in the shopper's currency. This same ratio is then applied and deducted in the shopper's currency.
2	Fixed in original currency	The discount value specified in `OriginalDiscountValue` denotes the fixed value in the merchant’s currency. When calculating the discount’s `DiscountValue`, only the respective FX rate should be applied to `OriginalDiscountValue`. No other price modifications (such as country coefficient) should be performed.
3	Fixed in customer currency	The discount value specified in `DiscountValue` denotes the fixed value nominated in end customer currency that should not be affected by any price modifications (such as country coefficient).

CalculationMode Option Value

Name

Description

1 (default)

Percentage discount

The discount value specified in OriginalDiscountValue should be used to calculate the DiscountValue as a percentage of the full product price (specified in Product.OriginalSalePrice for line item level discounts) or the cart price (sum of all Product.OriginalSalePrice values) for cart level discounts.

Note: The discount value provided is not a percentage. It represents the discount amount in your domestic currency. The ratio of the discount amount to the domestic price is calculated in the shopper's currency. This same ratio is then applied and deducted in the shopper's currency.

Fixed in original currency

The discount value specified in OriginalDiscountValue denotes the fixed value in the merchant’s currency. When calculating the discount’s DiscountValue, only the respective FX rate should be applied to OriginalDiscountValue. No other price modifications (such as country coefficient) should be performed.

Fixed in customer currency

The discount value specified in DiscountValue denotes the fixed value nominated in end customer currency that should not be affected by any price modifications (such as country coefficient).

Documentation Portal

Discount

Search results