Stores API

Stores API

1.0OAS 3.0

This API is used to query the Stores REST API.

API Base URL
  • Server 1:https://test-stores-api.intern.migros.net
Security
apikey (apiKey)

An API key is a token that you provide when making API calls. Include the token in a header parameter called X-Api-Key.

Example: X-Api-Key: 123

Additional Information

Retrieve a list of markets with given verbosity.

Retrieve a list of markets with given verbosity.

get
https://test-stores-api.intern.migros.net/migros/sales/branches/v1/markets

Query Parameters

idsAny Of

Array of market IDs or slugs

Default:[]

Example:["0090320_super","migros-supermarkt-abtwil-saentispark"]

Variant 1string
sap_idsAny Of
sapIdsstring

Array of SAP IDs

Default:[]

Example:, ["4213","5413"]

searchstring
sortstring

Default:name

orderstring

Allowed values:ascdesc

verbositystring

Allowed values:iddetail

aggregation_optionsstring

Aggregation options to apply for the given aggregations.

limitnumber | null

Limit the number of results.

>= 0<= 10000

Example:1, 10

offsetnumber | null

Offset the number of results

>= 0<= 10000

Example:0

location_referencestring
location_distancenumber | null
location_distance_unitstring

Allowed values:cmmkm

computed_opening_hoursobject

Computed opening hours. Must be an object with start and end properties. Start and end must be valid date strings in the format YYYYMMDD

Example:{"end":"20260930","start":"20260923"}

* Additional properties are NOT allowed.
Show Child Parameters
filtersAny Of

Filters to apply to the markets

Example:{"markets":["super","obi"]}

Variant 1object
* Additional properties are NOT allowed.
Show Child Parameters

Headers

Accept-Languagestring

The language of the results.

Allowed values:defrit

Default:de

Example:de

Response

application/json

List of markets.

marketsarray[object]required
Show Child Parameters
total_hitsnumberrequired
get/migros/sales/branches/v1/markets
 
application/json

Retrieve a market by id.

Retrieve a market by id.

get
https://test-stores-api.intern.migros.net/migros/sales/branches/v1/markets/{id}

Query Parameters

verbositystring

Allowed values:iddetail

computed_opening_hoursobject

Computed opening hours. Must be an object with start and end properties. Start and end must be valid date strings in the format YYYYMMDD

Example:{"end":"20260930","start":"20260923"}

* Additional properties are NOT allowed.
Show Child Parameters

Path Parameters

idstringrequired

Headers

Accept-Languagestring

The language of the results.

Allowed values:defrit

Default:de

Example:de

Response

application/json

A single market.

InvertedMarket

additional_slugsarray | null[string]required
admin_x_kststring | nullrequired
all_typesarray[string]required
assortmentsarray[object]required
Show Child Parameters
closing_dateAny Of
required
Variant 1string
computed_opening_hoursarray | null[object]required
Show Child Parameters
cooperativeobject | nullrequired
Show Child Parameters
cost_centerstringrequired
emailstring | nullrequired
facebook_idstring | nullrequired
full_namestringrequired
hintstring | nullrequired
idstringrequired
imageobject
Show Child Parameters
linksarray[object]required
Show Child Parameters
localized_slugsobjectrequired
Show Child Parameters
logoobjectrequired
Show Child Parameters
logo_minimalobjectrequired
Show Child Parameters
logo_squareobjectrequired
Show Child Parameters
managersarray[object]required
Show Child Parameters
mediaarray[object]required
Show Child Parameters
mpv_vertriebstyp_idstring | nullrequired
namestringrequired
opening_dateAny Of
required
Variant 1string
opening_hoursarray[object]required
Show Child Parameters
phonestring | nullrequired
prefixed_phonestring | nullrequired
sap_idstring | null
servicesarray[object]required
Show Child Parameters
slugstringrequired
sourcestring
special_day_schedulesarray[object]required
Show Child Parameters
sub_typesarray[string]required
typestringrequired
visit_frequenciesarray | null[object]required
Show Child Parameters
weblinkobject | nullrequired
Show Child Parameters
x_kststring | nullrequired
x_kst_gueltigabstring | nullrequired
storeobjectrequired
Show Child Parameters
get/migros/sales/branches/v1/markets/{id}
 
application/json