API
Data API
Stores
Methods allow you to get a list of portal stores or information on a specific store.

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