ClientApplyLoyaltyVouchers (Global-e to Merchant)

Note

This API is part of Global-e's extensions and plug-ins. Merchants do not need to implement this API unless a custom integration is required.

Use this method to validate the Loyalty Vouchers selected by the user from the list that has been provided in the loyaltyVouchersList argument of the SendCart API call for the current user’s checkout page. This method can only be executed from within the context of the current user’s client session. Validates Loyalty Vouchers and applies them to the current user’s cart if all the vouchers in the list are valid and applicable.

If at least one Loyalty Voucher in the list is invalid, Merchant.ResponseInfo.Success is set to FALSE.
If all Loyalty Vouchers are valid, the Merchant’s server should re-calculate the cart pricing and execute before returning a response, the SendCart API call with the CartToken argument value returned from the previous call to SendCart for the current user.

Method/URL

https://www.merchant-site-domain.com/ClientApplyLoyaltyVouchers

Parameters

Request

Name	Type	Description	Mandatory
`cartAction`	Object Merchant.CartAction	Delineates what action to perform with the cart data.	Yes

Response

Name	Type	Description	Mandatory
`Merchant.ResponseInfo`	Object `Merchant.ResponseInfo`	Describes the response to the API call. In case of an error, indicates the error.

Objects for ClientApplyLoyaltyVouchers API

Merchant.CartAction

Parameter Name	Type	Description	Mandatory
`CartHash`	String	Cart hash originally specified in the `merchantCartHash` argument for the `SendCart` method preceding the current cart action.	No
`CartId`	String	Identifier of the cart on the Merchant’s site originally specified in the `merchantCartToken` argument for the `SendCart` method preceding the current cart action.	No
`CartToken`	String	Cart token for the cart generated on the Global‑e side by the `SendCart` method preceding the current cart action. This property is mandatory only for server-side calls.	No
`LoyaltyVouchers`	String	A JSON-serialized array of Loyalty Voucher codes to be applied to the cart. This list is mandatory only in the `ClientApplyLoyaltyVouchers` method.	No
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e. This property is mandatory only for server-side calls.	No
`UserId`	String	Internal User identifier on the Merchant’s site originally specified in the shipping `details.UserId` argument for the `SendCart` method preceding the current cart action.	No

Merchant.ResponseInfo

Parameter Name	Type	Description	Mandatory
`Description`	String	Optional response description. In case of an error, this property indicates the error message description.	No
`ErrorCode`	String	Error code to be returned when an error occurs.	No
`InternalOrderId`	String	Order unique identifier on the Merchant’s site	Optional if there was an error, a failure, or if the action is not related to a specific order
`Message`	String	Optional response message. In case of an error, this property indicates the error message text.	No
`OrderId`	String	Order identifier on the Merchant’s site used for display and reporting purposes only. Unlike the `InternalOrderId`, this identifier is not necessarily unique over time, as the Merchant’s site may potentially reuse it (for example after deleting the old order having the same `OrderId`).	No
`PaymentAmount`	String	The total payment amount in `PaymentCurrency` charged for the order (if payment was processed in the respective API method call).	No
`PaymentCurrencyCode`	String	3-char ISO currency code for the order (if payment was processed in the respective API method call).	No
`StatusCode`	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).	Optional if there was an error or failure
`Success`	Boolean	Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.

Documentation Portal