Promotions API
Learn how to use the Promotions API.
You use the Promotions API to search, retrieve, and manage promotions. The API supports multiple promotion types including deals, coupons, price discounts, and basket building promotions, enabling you to programmatically monitor promotion status, review item selections, and identify validation issues.
Release notes
Note
All operations in the Promotions API are grantless.
To learn more about the terms that are used on this page, refer to Terminology.
Use cases
The following use cases examples are available for the Promotions API:
- Search for promotions: How to search and filter promotions.
- Get promotion item selection: How to retrieve the product items associated with a promotion.
- Get promotion details: How to retrieve comprehensive details for a specific promotion
Roles for the Promotions API v2025-12-01
searchPromotions
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Pricing Product Listing |
getPromotion
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Pricing Product Listing |
getSelection
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Pricing Product Listing |
Updated about 2 hours ago
Did this page help you?