--- title: "BoSS" url: "https://developer.migros.ch/apis/boss-8/versions/cdc38772-5e50-4428-9af6-e93327470df4" --- # BoSS 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"}}},"responses":{},"schemas":{"BossData":{"description":"Represents the BoSS information.","properties":{"bb_id":{"type":"string"},"best_practice":{"nullable":true,"type":"string"},"boss_number":{"description":"Status of the BoSS range.\n\n10 - Reserved\n20 - Planned\n30 - Active\n40 - Spinout\n50 - Inactive","type":"string"},"bw_id":{"type":"string"},"category_id":{"nullable":true,"type":"string"},"category_name":{"nullable":true,"type":"string"},"current_status":{"type":"string"},"current_valid_from":{"format":"date","type":"string"},"department_id":{"nullable":true,"type":"string"},"department_name":{"nullable":true,"type":"string"},"fa_id":{"type":"string"},"future_status":{"description":"Future status of the BoSS range.\n\n10 - Reserved\n20 - Planned\n30 - Active\n40 - Spinout\n50 - Inactive","nullable":true,"type":"string"},"future_valid_from":{"format":"date","type":"string"},"level":{"type":"integer"},"management_id":{"description":"ID of \"Direktion\".","nullable":true,"type":"string"},"management_name":{"description":"Name of \"Direktion\".","nullable":true,"type":"string"},"name":{"type":"string"},"responsible_person":{"nullable":true,"type":"string"},"rpa_flag":{"nullable":true,"type":"string"},"section_id":{"description":"ID of \"Sparte\".","nullable":true,"type":"string"},"section_name":{"description":"Name of \"Sparte\".","nullable":true,"type":"string"},"th_id":{"type":"string"},"vs_id":{"type":"string"}},"required":["boss_number","bb_id","bw_id","vs_id","th_id","fa_id","name","current_status","current_valid_from"],"type":"object"},"BossDataCollection":{"properties":{"boss":{"description":"Items of the collection.","items":{"$ref":"#/components/schemas/BossData"},"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.","type":"integer"}},"required":["boss","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":"Bedarfsorientierte Sortimentsstruktur (needs-oriented assortments structure): See Wiki","title":"BoSS","version":"8"},"openapi":"3.0.0","paths":{"/migros/products/v8/boss":{"get":{"description":"Returns all BoSS data.","operationId":"get-boss-data","parameters":[{"$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/BossDataCollection"}}},"description":"Returned when successful"}},"summary":"Returns all BoSS data.","tags":["BoSS"]}},"/migros/products/v8/boss/{boss_number}":{"get":{"description":"Returns BoSS data which is relevant to the given BoSS number.","operationId":"get-boss-data-by-boss-number","parameters":[{"description":"BoSS number to retrieve data for","in":"path","name":"boss_number","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/lang"},{"$ref":"#/components/parameters/Accept-Language"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BossDataCollection"}}},"description":"Returned when successful"}},"summary":"Returns BoSS data which is relevant to the given BoSS number.","tags":["BoSS"]}}},"security":[{"Kong-Api-Key":[],"basicAuth":[]}],"servers":[{"description":"Public Kong Gateway URL","url":"https://api.migros.ch"}],"tags":[{"name":"BoSS"},{"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"} ```