Accessing the PROMOTIONS resource

The promotions resource provides read only access to the product promotions on Aanbieders.be.

Choose the appropriate HTTP method

Resource HTTP format URL.format Description
Promotions GET /promotions.json Returns a list of promotions

By using this method, you can request a list of promotions. The promotions in this list are selected based on parameters that are either promotional or required and passed along with HTTP method.

Define the parameters

The promotions resource accepts a number of parameters based. You can either request explicit promotions by providing their IDs, or do a more Find-based approach to find all promotions operating in a certain product-area.

Promotion ID based search (when you provide a PromotionID this searh method gets priority, even if other params are provided)

Name Parameter Required Type Description
Promotion ID(s) promotion_id yes array Returns the promotions identified by the (array of) promotion_id
Language lang yes nl / fr Language
Detaillevel detaillevel no array Level of detail in response (see detaillevel-chapter)
Promo Type Filter promo_type no temporary/permanent Limit results to only temporary or permanent promotions

Detaillevel

Detaillevel gives you the possibility to scale down the response array. When you only need texts, you can add texts to your detaillevel array and will only get the text array in your output.

In this case, you have the choice in: