Merchant Promotions
Merchant Promotions Request#
The merchant promotions api returns all active promotions for the related merchant ID. The api can be used for all integration types (ecommerce and instore).
Please contact your Latitude Financial Services representative for information related to promotions and renewals.
Authentication#
Please refer to Authentication.
API Endpoints#
Latitude's endpoints to obtain the Merchant's active promotions (GET)
Content-Type: application/json All requests are via HTTPS GET
No parameters are required in the body.
| Environment | Endpoint |
| Test/Sandbox | https://api.test.latitudefinancial.com/v1/applybuy-checkout-service/promotions?merchantId=(insert merchantID) |
| Production | https://api.latitudefinancial.com/v1/applybuy-checkout-service/promotions?merchantId=(insert merchantID) |
Merchant Promotions Response#
Only active promotions are listed
Content-Type: application/json
| Key | Type | Example |
|---|---|---|
merchantID | string | T123344 |
promotions object, see Promotions Map | object of (active) promotions | see example |
Promotions Map (repeat for multiple promotions)#
| Key | Type | Example |
|---|---|---|
code Note: promotion code | string | 2012 |
description Note: promotion description | string | 12 Months Interest Free - Minimum Payments |
minimumPurchase Note: purchases over the minimum $ will qualify for the promotion | int | 250 represents $250 |
maximumPurchase Note: purchaes under the maximum $ will qualify for the promotion | int | 20000 represents $20,000 |
validFrom Note: the active period for the promotion | timestamp (UTC) | 2020-08-01T00:00:00Z |
validTill Note: the promotion's expiry. The promotion can only be applied to purchases during the promotion's active period | timestamp (UTC) | 2040-08-01T11:59:00Z |
Sample Merchant Promotions response