---
title: "Labels"
url: "https://developer-qual.migros.ch/apis/labels-8/versions/0e6de93c-9b6f-4b5c-b003-c0de2deadada"
---

# Labels

OpenAPI specification document.

```json
{"components":{"responses":{"400":{"description":"If the request parameters are invalid."},"404":{"description":"Returned when the requested resource could not be not found."}},"schemas":{"Image":{"description":"An image and its properties.","properties":{"original":{"description":"Full size image.","type":"string"},"stack":{"description":"Image URL with a placeholder for a Rokka {stack}.","type":"string"}},"type":"object"},"Label":{"description":"Represents the Label information in the Product.","properties":{"description":{"description":"The long description of the label (can contain HTML).","nullable":true,"type":"string"},"id":{"description":"ID of the label.","type":"string"},"image":{"description":"Image of the label.","nullable":true,"oneOf":[{"$ref":"#/components/schemas/Image"}]},"links":{"additionalProperties":{"$ref":"#/components/schemas/Link"},"description":"Collection of links indexed by string identifier.","type":"object"},"name":{"description":"Name of the label.","type":"string"},"position_for_product_title":{"description":"Indicates placement of the short name label in product title","nullable":true,"type":"string"},"short_name_for_product_title":{"description":"Shorter label variant of the product title","nullable":true,"type":"string"},"slug":{"description":"Unique user-friendly ID.","type":"string"}},"required":["id","name","slug"],"type":"object"},"LabelCollection":{"description":"A collection of label instances.","properties":{"labels":{"items":{"$ref":"#/components/schemas/Label"},"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"}},"required":["labels","total_hits"],"type":"object"},"Link":{"properties":{"url":{"description":"URL to a third-party desktop page of the product.","type":"string"}},"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":"Information about consumer labels, such as \"Bio\", \"Aus der Region\", \"Demeter\" etc.","title":"Labels","version":"8"},"openapi":"3.0.0","paths":{"/migros/products/v8/labels":{"get":{"description":"Returns a paged list of labels.","operationId":"getLabels","parameters":[{"description":"Maximum number of results (max 2000).","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":2000,"minimum":0,"type":"integer"}},{"description":"The language to be used. Possible values: `de`, `fr`, `it`, `en`. The language may also be set via HTTP header, e.g. `Accept-Language: de` header.","in":"query","name":"lang","required":false,"schema":{"default":"de","type":"string"}},{"description":"A comma separated list or an array of label ids defining the labels and the order in which the labels should be returned. If the ids parameter is provided all other filtering parameters are ignored.","in":"query","name":"ids","schema":{"type":"string"}},{"description":"The date and time used to only get labels 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. Default time zone is Swiss time.","in":"query","name":"updated_since","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelCollection"}}},"description":"Returned when successful"},"400":{"$ref":"#/components/responses/400"}},"summary":"Returns a paged list of labels.","tags":["Labels"]}},"/migros/products/v8/labels/{id}":{"get":{"description":"Returns information about a single label by ID or slug.","operationId":"getLabel","parameters":[{"description":"Resource ID.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The language to be used. Possible values: `de`, `fr`, `it`, `en`. The language may also be set via HTTP header, e.g. `Accept-Language: de` header.","in":"query","name":"lang","required":false,"schema":{"default":"de","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}}},"description":"Returned when successful"},"404":{"$ref":"#/components/responses/404"}},"summary":"Returns information about a single label by ID or slug.","tags":["Labels"]}}},"security":[{"Kong-Api-Key":[]},{"basicAuth":[]}],"servers":[{"description":"Public Kong Gateway URL","url":"https://api-qual.migros.ch"}],"tags":[{"name":"Labels"},{"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":2,"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"}
```