---
title: "Get a paged list of ZIP codes and their associated information for all countries."
url: "https://developer-qual.migros.ch/apis/cooperatives-8/versions/f857e568-6a4c-420a-9cd1-c4f6093497f5/operations/get-cooperatives"
---

> Full API specification: https://developer-qual.migros.ch/apis/cooperatives-8/versions/f857e568-6a4c-420a-9cd1-c4f6093497f5.md

# Get a paged list of ZIP codes and their associated information for all countries.

`GET` `/migros/products/v8/cooperatives`

Operation ID: `get-cooperatives`

Get a paged list of ZIP codes and their associated information for all countries.

## Query parameters

- `search` (string, optional) - Simple search string which is fault-tolerant for user-entered text.
- `limit` (integer, optional) - Maximum number of results (max 2000).
- `offset` (integer, optional) - Result set offset.
- `lang` (string, optional) - 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.

## Header parameters

- `Accept-Language` (string, optional) - 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.

## Responses

- `200` - Returned when successful
- `400` - If the request parameters are invalid.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Cooperatives
  version: "8"
servers:
  - description: Public Kong Gateway URL
    url: https://api-qual.migros.ch
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
security:
  - Kong-Api-Key: []
    basicAuth: []
components:
  parameters:
    search:
      description: Simple search string which is fault-tolerant for user-entered text.
      in: query
      name: search
      required: false
      schema:
        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
    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
    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
  schemas:
    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
    AbstractSearchResultCollection:
      allOf:
        - $ref: "#/components/schemas/AbstractCollection"
        - properties:
            ids:
              description: >-
                Ids only.


                Is filled instead of the usual property for content, with only
                the ids when a call is made with verbosity=id on a

                route that supports it.
              items:
                type: string
              type: array
            total_hits:
              description: >-
                The total hits may exceed the actual count of results in the
                collection.


                It represents the total number of results of a search and not
                only the

                potentially 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
    AbstractCollection:
      description: A generic collection of elements.
    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
  responses:
    "400":
      description: If the request parameters are invalid.
  securitySchemes:
    Kong-Api-Key:
      description: Kong key-auth authentication
      in: header
      name: X-Api-Key
      type: apiKey
    basicAuth:
      scheme: basic
      type: http
```