---
title: Stores
slug: stores
docTags:
createdAt: 2022-04-14T07:57:58.000Z
---
Methods allow you to get a list of portal stores or information on a specific store.
***
::::ExpandableHeading
# GET /stores
Return a list of stores.
:::ApiMethodV2
```json
{
"tab": "examples",
"url": "https://instance_name/api/data/v1.0/stores/",
"name": "Request example",
"method": "GET",
"request": {
"pathParameters": [],
"queryParameters": [],
"headerParameters": [
{
"kind": "required",
"name": "Authorization",
"type": "string",
"description": "String in \"Token XXXXXX...\" format."
}
],
"bodyDataParameters": [
{
"kind": "optional",
"name": "limit",
"type": "Integer",
"description": "The number of results to return per page."
},
{
"kind": "optional",
"name": "offset",
"type": "Integer",
"description": "The initial index from which to return the results."
}
],
"formDataParameters": []
},
"results": {
"languages": [
{
"id": "FJ3zsBaijz6TuVFI40xNy",
"code": "{\n \"count\": 45,\n \"next\": null,\n \"previous\": \"https://test.eyrene.com/api/data/v1.0/tasks/?limit=30&offset=30\",\n \"results\": [\n {\n \"id\": 15618,\n \"route\": \"864760\",\n \"route_type_description\": null,\n \"customer_id\": \"{3F8B66BE-154D-E711-80FA-0050560114}\",\n \"customer_name\": \"BR20 X5 Zemgales\",\n \"region\": \"Riga\",\n \"region_l3\": null,\n \"region_l4\": null,\n \"area\": \"nan\",\n \"area_l5\": null,\n \"area_l6\": null,\n \"city\": \"Riga\",\n \"sales_route_id\": null,\n \"latitude\": 59.74551,\n \"longitude\": 30.091282,\n \"created_at\": \"2021-06-02T00:17:01.782397Z\",\n \"updated_at\": \"2021-09-14T00:56:20.310019Z\",\n \"address\": \"Rītausmas iela 23, Zemgales priekšpilsēta, Riga, LV-1058, Latvia\",\n \"distr_name\": null,\n \"team_id\": null,\n \"rsm_name\": null,\n \"rsm_code\": null,\n \"tsm_name\": null,\n \"route_type_full\": null,\n \"segment\": \"west\",\n \"pos_code\": null,\n \"matrix_name\": null,\n \"gtm_role_id_description\": null,\n \"id_dealer\": null,\n \"golden_id\": null,\n \"sector\": null,\n \"manager\": null,\n \"inn\": null,\n \"kpp\": null,\n \"sale_channel\": null,\n \"country\": \"Latvia\",\n \"fss\": null,\n \"fss_code\": null,\n \"sfss\": null,\n \"sfss_code\": null,\n \"em\": null,\n \"em_code\": null,\n \"agency\": null,\n \"agency_region\": null,\n \"kam_food\": null,\n \"kam_food_code\": null,\n \"kam_hpc\": null,\n \"kam_hpc_code\": null,\n \"ctl\": null,\n \"ctl_code\": null,\n \"mte\": null,\n \"mte_code\": null,\n \"nsd\": null,\n \"nsd_code\": null,\n \"visit_plan_id\": null,\n \"driver_id\": null,\n \"sap_code\": null,\n \"sales_group\": null,\n \"visit_type\": null,\n \"hierarchy_l5\": null,\n \"hierarchy_l6\": null,\n \"visit_frequency\": null,\n \"dsd_distr\": null,\n \"store_number\": null,\n \"virtual_flag\": null,\n \"lka_segment\": null,\n \"customer_segment\": null,\n \"y_cust_hier_level_6\": null,\n \"y_cust_hier_level_8\": null,\n \"store_format\": \"BR20\",\n \"team_route\": null,\n \"route_type_dsd\": null,\n \"route_merch\": null,\n \"service_type\": null,\n \"svm\": null,\n \"tm\": null,\n \"rmm\": null,\n \"kam_ekam\": null,\n \"skam\": null,\n \"days_sequence_code\": null,\n \"weekly_frequency\": null,\n \"bm\": null,\n \"sv\": null,\n \"se\": null,\n \"task_type\": null,\n \"task_subtype\": null,\n \"enabled\": true,\n \"week_days\": \"1,2,3,4,5,6,7\",\n \"uuid\": \"e1b337c4-2fb2-447c-8d05-78978954\",\n \"global_channel\": null,\n \"sync_point\": null,\n \"master_code\": null,\n \"dt\": null,\n \"svme\": null,\n \"me\": null,\n \"description_toloka\": null,\n \"visits_per_month\": 1,\n \"supervisor_code\": null,\n \"ka_dt\": null,\n \"svme_code\": null,\n \"svme_email\": null,\n \"me_code\": null,\n \"json\": {\n \"GLN\": \"4606038014604\",\n \"ROUTE\": {\n \"...\"\n },\n \"own_id\": \"5497\",\n \"SM_link\": \"https://xcrm.s3.dtln.ru/f6ae3fb2-d004-ec11-8121654688.pdf\",\n \"segment\": \"west\",\n \"cdc_city\": \"Riga\",\n \"AccountId\": \"{3F8B66BE-154D-E711-80FA-005056011415}\",\n \"Tier_Name\": \"Top 2\",\n \"Tier_code\": 969790004,\n \"cz_matrix\": 200929,\n \"osa_alert\": false,\n \"PS_TARGETS\": [\n {\n \"target\": 42,\n \"kpi_cid\": \"PS/Home Shelf/Golden Sku\",\n \"category\": \"Home Shelf\"\n },\n {\n \"target\": 117,\n \"kpi_cid\": \"PS/Home Shelf/Golden Sku\",\n \"category\": \"Animal food\"\n },\n {\n \"target\": 28,\n \"kpi_cid\": \"PS/Home Shelf/Other Sku\",\n \"category\": \"Animal food\"\n },\n {\n \"target\": 10,\n \"kpi_cid\": \"PS/Home Shelf/Multi Facing\",\n \"category\": \"Animal food\"\n },\n {\n \"target\": 5,\n \"kpi_cid\": \"PS/Home Shelf/Multi Facing\",\n \"category\": \"Cooking\"\n }\n ],\n \"brand_code\": 1303,\n \"brand_name\": \"X5 Retail Group\",\n \"cdc_region\": \"Riga\",\n \"cdc_street\": \"Rītausmas iela 23\",\n \"mml_matrix\": null,\n \"short_name\": \"BR20 X5 Zemgales\",\n \"banner_code\": 4656,\n \"banner_name\": \"\",\n \"cdc_country\": \"Latvia\",\n \"format_name\": \"BR20\",\n \"list_matrix\": 200931,\n \"stream_name\": \"\",\n \"MATRIX_NAMES\": {\n \"Total\": null,\n \"Coffee\": \"\",\n \"Cooking\": \"\",\n },\n \"SM_link_xlsx\": \"https://xcrm.s3.dtln.ru/f6ae3fb2-d004-ec11-8121-468464548.xlsx\",\n \"cash_counter\": 3,\n \"cdc_building\": \"4\",\n \"cdc_district\": null,\n \"cdc_latitude\": 59.74551,\n \"cdc_location\": null,\n \"channel_name\": \"Supermarket Small\",\n \"assort_matrix\": null,\n \"cdc_longtitude\": 30.091282,\n \"rec_time_visit\": 140,\n \"merch_standards\": {\n \"Coffee\": {\n \"standard\": \"...\",\n \"started_at\": \"2021-05-01\",\n \"standard_plus\": \"...\"\n },\n \"Cooking\": {\n \"standard\": \"...\",\n \"started_at\": \"2021-05-01\",\n \"standard_plus\": \"...\"\n }\n },\n \"assort_matrix_CPW\": 398643,\n \"promo_format_code\": 886788,\n \"promo_format_name\": 4,\n \"new_products_matrix\": null,\n \"assort_matrix_Purina\": 190463,\n \"assort_matrix_coffee\": 398492,\n \"cdc_normalizedaddress\": \"Rītausmas iela 23, Zemgales priekšpilsēta, Riga, LV-1058, Latvia\",\n \"inout_products_matrix\": null,\n \"status_normalize_code\": 0,\n \"status_normalize_name\": \"Exact coordinates\",\n \"assort_matrix_bistroff\": 19136,\n \"assort_matrix_kulinary\": 64862,\n \"assort_matrix_nutrition\": 19331,\n \"assort_matrix_confectionery\": 68348\n },\n \"description\": \"\",\n \"retail_chain\": 23,\n \"logo\": 81679447,\n \"store_type\": 6,\n \"group\": null,\n \"agent_routes\": [\n 3645,\n 6823,\n 7209\n ]\n }\n ...\n ]\n}",
"language": "200",
"customLabel": ""
}
],
"selectedLanguageId": "FJ3zsBaijz6TuVFI40xNy"
},
"examples": {
"languages": [
{
"id": "dpmODah_ZAOTKtuSexN5X",
"code": "curl –i –X GET\n https://test.eyrene.com/api/data/v1.0/stores/\n -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’\n –F \"limit=1\" \\\n –F \"offset=0\"",
"language": "curl",
"customLabel": ""
}
],
"selectedLanguageId": "dpmODah_ZAOTKtuSexN5X"
},
"description": "GET /stores",
"currentNewParameter": {
"label": "Body Parameter",
"value": "bodyDataParameters"
},
"autoGeneratedAnchorSlug": "request-example",
"legacyHash": "3U7CwoBr0wxsJM3qTVE10"
}
```
:::
::::
***
::::ExpandableHeading
# GET /stores/\{id}
Returns information about store by ID.
:::ApiMethodV2
```json
{
"tab": "examples",
"url": "https://instance_name/api/data/v1.0/stores/{id}",
"name": "Request example",
"method": "GET",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "id",
"type": "string",
"description": "Stores ID."
}
],
"queryParameters": [],
"headerParameters": [
{
"kind": "required",
"name": "Authorization",
"type": "string",
"description": "String in \"Token XXXXXX...\" format"
}
],
"bodyDataParameters": [],
"formDataParameters": []
},
"results": {
"languages": [
{
"id": "FJ3zsBaijz6TuVFI40xNy",
"code": "{\n \"id\": 15618,\n \"route\": \"864760\",\n \"route_type_description\": null,\n \"customer_id\": \"{3F8B66BE-154D-E711-80FA-0050560114}\",\n \"customer_name\": \"BR20 X5 Zemgales\",\n \"region\": \"Riga\",\n \"region_l3\": null,\n \"region_l4\": null,\n \"area\": \"nan\",\n \"area_l5\": null,\n \"area_l6\": null,\n \"city\": \"Riga\",\n \"sales_route_id\": null,\n \"latitude\": 59.74551,\n \"longitude\": 30.091282,\n \"created_at\": \"2021-06-02T00:17:01.782397Z\",\n \"updated_at\": \"2021-09-14T00:56:20.310019Z\",\n \"address\": \"Rītausmas iela 23, Zemgales priekšpilsēta, Riga, LV-1058, Latvia\",\n \"distr_name\": null,\n \"team_id\": null,\n \"rsm_name\": null,\n \"rsm_code\": null,\n \"tsm_name\": null,\n \"route_type_full\": null,\n \"segment\": \"west\",\n \"pos_code\": null,\n \"matrix_name\": null,\n \"gtm_role_id_description\": null,\n \"id_dealer\": null,\n \"golden_id\": null,\n \"sector\": null,\n \"manager\": null,\n \"inn\": null,\n \"kpp\": null,\n \"sale_channel\": null,\n \"country\": \"Latvia\",\n \"fss\": null,\n \"fss_code\": null,\n \"sfss\": null,\n \"sfss_code\": null,\n \"em\": null,\n \"em_code\": null,\n \"agency\": null,\n \"agency_region\": null,\n \"kam_food\": null,\n \"kam_food_code\": null,\n \"kam_hpc\": null,\n \"kam_hpc_code\": null,\n \"ctl\": null,\n \"ctl_code\": null,\n \"mte\": null,\n \"mte_code\": null,\n \"nsd\": null,\n \"nsd_code\": null,\n \"visit_plan_id\": null,\n \"driver_id\": null,\n \"sap_code\": null,\n \"sales_group\": null,\n \"visit_type\": null,\n \"hierarchy_l5\": null,\n \"hierarchy_l6\": null,\n \"visit_frequency\": null,\n \"dsd_distr\": null,\n \"store_number\": null,\n \"virtual_flag\": null,\n \"lka_segment\": null,\n \"customer_segment\": null,\n \"y_cust_hier_level_6\": null,\n \"y_cust_hier_level_8\": null,\n \"store_format\": \"BR20\",\n \"team_route\": null,\n \"route_type_dsd\": null,\n \"route_merch\": null,\n \"service_type\": null,\n \"svm\": null,\n \"tm\": null,\n \"rmm\": null,\n \"kam_ekam\": null,\n \"skam\": null,\n \"days_sequence_code\": null,\n \"weekly_frequency\": null,\n \"bm\": null,\n \"sv\": null,\n \"se\": null,\n \"task_type\": null,\n \"task_subtype\": null,\n \"enabled\": true,\n \"week_days\": \"1,2,3,4,5,6,7\",\n \"uuid\": \"e1b337c4-2fb2-447c-8d05-78978954\",\n \"global_channel\": null,\n \"sync_point\": null,\n \"master_code\": null,\n \"dt\": null,\n \"svme\": null,\n \"me\": null,\n \"description_toloka\": null,\n \"visits_per_month\": 1,\n \"supervisor_code\": null,\n \"ka_dt\": null,\n \"svme_code\": null,\n \"svme_email\": null,\n \"me_code\": null,\n \"json\": {\n \"GLN\": \"4606038014604\",\n \"ROUTE\": {\n \"...\"\n },\n \"own_id\": \"5497\",\n \"SM_link\": \"https://xcrm.s3.dtln.ru/f6ae3fb2-d004-ec11-8121654688.pdf\",\n \"segment\": \"west\",\n \"cdc_city\": \"Riga\",\n \"AccountId\": \"{3F8B66BE-154D-E711-80FA-005056011415}\",\n \"Tier_Name\": \"Top 2\",\n \"Tier_code\": 969790004,\n \"cz_matrix\": 200929,\n \"osa_alert\": false,\n \"PS_TARGETS\": [\n {\n \"target\": 42,\n \"kpi_cid\": \"PS/Home Shelf/Golden Sku\",\n \"category\": \"Home Shelf\"\n },\n {\n \"target\": 117,\n \"kpi_cid\": \"PS/Home Shelf/Golden Sku\",\n \"category\": \"Animal food\"\n },\n {\n \"target\": 28,\n \"kpi_cid\": \"PS/Home Shelf/Other Sku\",\n \"category\": \"Animal food\"\n },\n {\n \"target\": 10,\n \"kpi_cid\": \"PS/Home Shelf/Multi Facing\",\n \"category\": \"Animal food\"\n },\n {\n \"target\": 5,\n \"kpi_cid\": \"PS/Home Shelf/Multi Facing\",\n \"category\": \"Cooking\"\n }\n ],\n \"brand_code\": 1303,\n \"brand_name\": \"X5 Retail Group\",\n \"cdc_region\": \"Riga\",\n \"cdc_street\": \"Rītausmas iela 23\",\n \"mml_matrix\": null,\n \"short_name\": \"BR20 X5 Zemgales\",\n \"banner_code\": 4656,\n \"banner_name\": \"\",\n \"cdc_country\": \"Latvia\",\n \"format_name\": \"BR20\",\n \"list_matrix\": 200931,\n \"stream_name\": \"\",\n \"MATRIX_NAMES\": {\n \"Total\": null,\n \"Coffee\": \"\",\n \"Cooking\": \"\",\n },\n \"SM_link_xlsx\": \"https://xcrm.s3.dtln.ru/f6ae3fb2-d004-ec11-8121-468464548.xlsx\",\n \"cash_counter\": 3,\n \"cdc_building\": \"4\",\n \"cdc_district\": null,\n \"cdc_latitude\": 59.74551,\n \"cdc_location\": null,\n \"channel_name\": \"Supermarket Small\",\n \"assort_matrix\": null,\n \"cdc_longtitude\": 30.091282,\n \"rec_time_visit\": 140,\n \"merch_standards\": {\n \"Coffee\": {\n \"standard\": \"...\",\n \"started_at\": \"2021-05-01\",\n \"standard_plus\": \"...\"\n },\n \"Cooking\": {\n \"standard\": \"...\",\n \"started_at\": \"2021-05-01\",\n \"standard_plus\": \"...\"\n }\n },\n \"assort_matrix_CPW\": 398643,\n \"promo_format_code\": 886788,\n \"promo_format_name\": 4,\n \"new_products_matrix\": null,\n \"assort_matrix_Purina\": 190463,\n \"assort_matrix_coffee\": 398492,\n \"cdc_normalizedaddress\": \"Rītausmas iela 23, Zemgales priekšpilsēta, Riga, LV-1058, Latvia\",\n \"inout_products_matrix\": null,\n \"status_normalize_code\": 0,\n \"status_normalize_name\": \"Exact coordinates\",\n \"assort_matrix_bistroff\": 19136,\n \"assort_matrix_kulinary\": 64862,\n \"assort_matrix_nutrition\": 19331,\n \"assort_matrix_confectionery\": 68348\n },\n \"description\": \"\",\n \"retail_chain\": 23,\n \"logo\": 81679447,\n \"store_type\": 6,\n \"group\": null,\n \"agent_routes\": [\n 3645,\n 6823,\n 7209\n ]\n }\n ...\n ]\n}",
"language": "200",
"customLabel": ""
}
],
"selectedLanguageId": "FJ3zsBaijz6TuVFI40xNy"
},
"examples": {
"languages": [
{
"id": "dpmODah_ZAOTKtuSexN5X",
"code": "curl –i –X GET\n https://test.eyrene.com/api/data/v1.0/stores/15618/\n -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’",
"language": "curl",
"customLabel": ""
}
],
"selectedLanguageId": "dpmODah_ZAOTKtuSexN5X"
},
"description": "GET /stores/{id}",
"currentNewParameter": {
"label": "Path Parameter",
"value": "pathParameters"
},
"autoGeneratedAnchorSlug": "request-example-1",
"legacyHash": "T154FeJB35XaxNxI2PeYp"
}
```
:::
::::
***