Simple search string which is fault-tolerant for user-entered text.
Maximum number of results (max 2000).
Default:10
>= 0<= 2000
Result set offset.
Default:0
>= 0
Selected facet terms as readable string or indexed array by facet name, e.g. ?facets[facet_name][]=123&facets[facet_name][]=456.
Maximum number of terms for each facet to include in the response. -1 returns no facets at all and 0 returns all terms.
Defines additional facets that should be returned. Possible values: ‘category’. Example: ?extra_facets[]=category
The sorting criteria.
Allowed values:scorepricecategoryidnameratingrating_roundedrating_rounded_tenthreviewsupdated_atboss_numberbrand_namepim_status
Default:score
The ordering direction.
Allowed values:ascdesc
Default:asc
When sorting by category the sorting will be done by the children of the categories passed in this parameter. For each product the first category matching from the bottom will be taken. The following two formats are valid for this parameter: ?roots=code1,code2 or ?roots[]=code1&roots[]=code2.
Get the price for this region. Output in the ‘price’ field and used for sorting by price. If you specify ‘all’, prices for all regions are additionally output in ‘regional_information’.
Allowed values:nationalgmaagmbsgmgegmlugmnfgmosgmtigmvdgmvsgmzhall
Default:national
Filter the list of products by their availability in the given region. Availability is based on supermarket stores (M, MM, MMM, Voi, Migros Partner), and assumes that the product is available in at least a percentage of those stores, see regional_available_min_percentage for default value.
Allowed values:gmaagmbsgmgegmlugmnfgmosgmtigmvdgmvsgmzhnational
Specify the minimum percentage of the availability in the region to be used. This parameter can be used only with the regional_available. Default value is 60% for the product search. Note: 1% means that the product is available at least in one store
>= 1<= 100
Use a different source to use for prices than the default PriceRepo system. To get shop prices, specify the price_channel. You can’t specify both this and price_channel in the same request.
Allowed values:pim
Get the shop prices for the specified channel. Only national prices will be available in regional_information. You can’t specify both this and price_source in the same request. When using this parameter, price boosting, filtering by discounts, discount_campaigns, discount_events or discount_types and sorting by price uses the price repo prices, and not the specified shop price. Visibility will look at the price repository price, not the shop price of the specified channel.
Allowed values:01020304050607080910111299
Set to ‘all’ to output regional prices in the regional_information field if available.
Allowed values:all
The date and time used to only get products updated since a certain timestamp. The format is according to ISO 8601 and can include a time zone offset, e.g. 2018-01-01T06:00:00+01:00 (careful about the plus getting properly percent-encoded when passed). Default time zone is Swiss time.
Display only products which belong to the specified discount. This filter still works, but is deprecated as of version 2.
Display only products which belong to the specified discounts. This filter respects the region parameter, so the discount has be in the given region or national. Note: A discount sometimes applies to many products, you need to do paging in case the limit is hit (see limit parameter).
Display only products which belong to the specified discount campaign. This will also return the specific discount on the product.
Display only products which belong to the specified discount event. This will also return the specific discount on the product.
Display only products which have a discount with the given discount_type_id. Multiple can be given, seperated by a comma. Product must have at least one of the specified discount types to pass the filter. Will respect the region parameter if set and use that in addition to national discounts.
A comma separated list or an array of gtins for filtering the products. The order of the gtins has no effect on the order of the returned products.
A comma separated list or an array of tags for filtering the products. The products must contain one of the specified tags.
A single store id. If set, the result is limited to products available at that store.
A comma separated list or an array of supplier ids for filtering the products.
The RecipeIngredient ID to filter the products for. Only a single id is supported, as otherwise it would be impossible from the result to know which products belongs to which ingredient id.
A comma separated list or an array of product ids defining the products and the order in which the products should be returned. If the ids parameter is provided all other filtering parameters are ignored.
A comma separated list of boss_numbers prefixes to filter products for.
Filter for only products in this online channel. e.g. MO, MGB (for supermarket), MYM or ALN. A comma separated list or an array
Return specific set of products. Either ‘all’ (active and inactive/incomplete products), ‘browse’ (active products excluding Alnatura products), or ‘browseallretailers’ (active products including Alnatura products).
Allowed values:allbrowsebrowseallretailers
Default:browse
Verbosity of output. If not specified, outputs information usually needed on product lists. You can output a flat list of product ids with ‘id’ or show all details as in the product detail route with ‘detail’.
Allowed values:idlistdetailfull
Enable alternate scoring system, for A/B search testing
Use the given search mode (warning: changing the search_mode is meant only for specific cases).
Allowed values:defaultabtestingartikelabfragecustomized
A comma separated list or an array of fields where the search should be executed in (only valid with search_mode=customized). This is meant for testing purposes only.
A comma separated list or an array of product IDs to search in (sort is not altered by this filter). Take care of the request size when passing a huge number of IDs. More product-IDs may also be passed in the POST request body. Ask the M-API team for more details.
Whether to output the custom image format with placeholders for width and height.
Default:false
Whether to output products that are variants. If this parameter is omitted, it returns both variants and base products.
A comma separated list of one catalog ids for filtering the products.