--- title: "Cooperatives" url: "https://developer-qual.migros.ch/apis/cooperatives-8/versions/f857e568-6a4c-420a-9cd1-c4f6093497f5" --- # Cooperatives OpenAPI specification document. ```json {"components":{"parameters":{"Accept-Language":{"description":"Defines the language (de/fr/it/en) for this request as request header. Either use the query param \"lang\" or header \"Accept-Language\", not both.","in":"header","name":"Accept-Language","schema":{"default":"de","enum":["de","fr","it","en"],"type":"string"}},"lang":{"description":"Defines the language (de/fr/it/en) for this request as query parameter. Either use the query param \"lang\" or header \"Accept-Language\", not both.","in":"query","name":"lang","schema":{"default":"de","enum":["de","fr","it","en"],"type":"string"}},"limit":{"description":"Maximum number of results (max 2000).","in":"query","name":"limit","required":false,"schema":{"default":10,"maximum":2000,"minimum":0,"type":"integer"}},"offset":{"description":"Result set offset.","in":"query","name":"offset","required":false,"schema":{"default":0,"minimum":0,"type":"integer"}},"search":{"description":"Simple search string which is fault-tolerant for user-entered text.","in":"query","name":"search","required":false,"schema":{"type":"string"}}},"responses":{"400":{"description":"If the request parameters are invalid."},"404":{"description":"Returned when the requested resource could not be not found."}},"schemas":{"AbstractCollection":{"description":"A generic collection of elements."},"AbstractSearchResultCollection":{"allOf":[{"$ref":"#/components/schemas/AbstractCollection"},{"properties":{"ids":{"description":"Ids only.\n\nIs filled instead of the usual property for content, with only the ids when a call is made with verbosity=id on a\nroute that supports it.","items":{"type":"string"},"type":"array"},"total_hits":{"description":"The total hits may exceed the actual count of results in the collection.\n\nIt represents the total number of results of a search and not only the\npotentially paginated subset.","nullable":true,"type":"integer"}},"type":"object"}],"description":"A collection of search result instances.","type":"object"},"Zip":{"description":"Zip info, with city and cooperative mapping.","properties":{"adr_regions":{"items":{"$ref":"#/components/schemas/ZipAdrRegion"},"nullable":true,"type":"array"},"city":{"type":"string"},"city_names":{"description":"Names of this city in all languages.","items":{"type":"string"},"nullable":true,"type":"array"},"cooperative":{"description":"Shortname of cooperative.","type":"string"},"cooperative_email":{"nullable":true,"type":"string"},"cooperative_homepage":{"nullable":true,"type":"string"},"country":{"description":"The country code of this Zip (e.g. CH, FL, DE, FR, IT, AT)","type":"string"},"state":{"description":"State/canton name (*not* the country).","type":"string"},"zip":{"type":"string"}},"required":["zip","city","cooperative"],"type":"object"},"ZipAdrRegion":{"description":"\"Aus der Region, für die Region\" info for zip.","properties":{"language":{"enum":["de","fr","it"],"type":"string"},"name":{"description":"Language of the region.","type":"string"}},"type":"object"},"ZipCollection":{"allOf":[{"$ref":"#/components/schemas/AbstractSearchResultCollection"},{"properties":{"zips":{"items":{"$ref":"#/components/schemas/Zip"},"type":"array"}},"type":"object"}],"description":"A collection of zip instances.","required":["zips","total_hits"],"type":"object"}},"securitySchemes":{"Kong-Api-Key":{"description":"Kong key-auth authentication","in":"header","name":"X-Api-Key","type":"apiKey"},"basicAuth":{"scheme":"basic","type":"http"}}},"info":{"contact":{"email":"arg_mgb-udp-products-services@mgb.ch","name":"MGB-UDP-Products-Services"},"description":"Get information about cooperatives and AdR-regions. See Wiki","title":"Cooperatives","version":"8"},"openapi":"3.0.0","paths":{"/migros/products/v8/cooperatives":{"get":{"description":"Get a paged list of ZIP codes and their associated information for all countries.","operationId":"get-cooperatives","parameters":[{"$ref":"#/components/parameters/search"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/lang"},{"$ref":"#/components/parameters/Accept-Language"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZipCollection"}}},"description":"Returned when successful"},"400":{"$ref":"#/components/responses/400"}},"summary":"Get a paged list of ZIP codes and their associated information for all countries.","tags":["Cooperatives"]}},"/migros/products/v8/cooperatives/{country}":{"get":{"description":"Returns a paged list of ZIP codes and their associated information for a country.","operationId":"get-cooperatives-by-country","parameters":[{"description":"Country code, for example CH, DE etc (note that places in 'Fürstentum Liechtenstein' are found under CH, not FL)","in":"path","name":"country","required":true,"schema":{"pattern":"[A-Z]{2}","type":"string"}},{"$ref":"#/components/parameters/search"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/lang"},{"$ref":"#/components/parameters/Accept-Language"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZipCollection"}}},"description":"Returned when successful"},"400":{"$ref":"#/components/responses/400"}},"summary":"Returns a paged list of ZIP codes and their associated information for a country.","tags":["Cooperatives"]}},"/migros/products/v8/cooperatives/{country}/{zip}":{"get":{"description":"Returns the associated city and Migros cooperative for a single ZIP code in the specified country.","operationId":"get-cooperatives-by-country-and-zip","parameters":[{"description":"Country code, for example CH, DE etc (note that places in 'Fürstentum Liechtenstein' are found under CH, not FL)","in":"path","name":"country","required":true,"schema":{"type":"string"}},{"in":"path","name":"zip","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/lang"},{"$ref":"#/components/parameters/Accept-Language"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zip"}}},"description":"Returned when successful"},"404":{"$ref":"#/components/responses/404"}},"summary":"Returns the associated city and Migros cooperative for a single ZIP code in the specified country.","tags":["Cooperatives"]}}},"security":[{"Kong-Api-Key":[],"basicAuth":[]}],"servers":[{"description":"Public Kong Gateway URL","url":"https://api-qual.migros.ch"}],"tags":[{"name":"Cooperatives"},{"name":"mapi"}],"x-active-from":"01-01-2024","x-company":"migros","x-edm-domain":"products","x-eol":"31-12-2049","x-headmatter":{"readable_by":"*"},"x-kong-route-defaults":{"protocols":["https"],"strip_path":false},"x-kong-service-defaults":{"connect_timeout":5000,"read_timeout":15000,"retries":1,"write_timeout":5000},"x-leanix-id":"350641a5-55a2-4641-8332-76d32846eb56","x-link-get-access":"https://forms.office.com/e/zhzbEqAQ26","x-link-get-support":"https://teams.microsoft.com/l/channel/19%3Aa7851e50d0194268ba0c7a0d7a63403b%40thread.tacv2/2.%20Support%20%F0%9F%92%A1?groupId=58b919a5-7d36-47f3-a77a-03cfd051098a&tenantId=35aa8c5b-ac0a-4b15-9788-ff6dfa22901f"} ```