Skip to main content

GET /stores

Returns a list of stores.

Address: GET https://instance_name/api/data/v1.3/stores/

Content-type: application/json

Request body parameters


limit integer

Number of results to return per page.


offset integer

The initial index from which to return the results.


Request example

curl –i –X GET
https://test.inspector-cloud.com/api/v1.3/stores/
-H ‘Authorization: Token <<your_token>>
–F "limit=1" \
–F "offset=0"

Response example

Response code: 200

{
"count": 45,
"next": null,
"previous": "https://test.inspector-cloud.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 Пятерочка Санкт-Петербург Стрельнинское 4",
"region": "Санкт-Петербург",
"region_l3": null,
"region_l4": null,
"area": "nan",
"area_l5": null,
"area_l6": null,
"city": "Красное Село",
"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": "г Санкт-Петербург, г Красное Село, ш Стрельнинское, д 4",
"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": "Россия",
"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": {
"SV_ter": "GC_Лен обл Гатчина/Петергоф_SV",
"DSM_ter": "GC_Лен обл_DSM",
"Guid_SV": "{19B9E127-1C35-E911-811D-0050560114}",
"RSM_ter": "GC_NW_Energo_NM_SM",
"Guid_DSM": "{82F261C7-1A35-E911-811D-0050560114}",
"Guid_RSM": "{57B830BE-7C96-E911-811E-0050560114}",
"Guid_ter": "{62875CF0-3A0A-EC11-8121-0050560114}",
"SV_login": "NW_EN_NM",
"Merch_ter": "GC_Красное село_3_mch",
"Partner_ID": "P19",
"mecrh_type": "Мобильный",
"SV_TER_LIST": [
"GC_Лен обл Гатчина/Петергоф_SV"
],
"merch_login": "NW_EN_NM_M0763",
"GUID_SV_LIST": [
"{19B9E127-1C35-E911-811D-005056011415}"
],
"Partner_Name": "Energo",
"route_segment": "west",
"Sales_District_ID": "RU07",
"Sales_District_Name": "RU GC North-West"
},
"own_id": "5497",
"SM_link": "https://xcrm.s3.dtln.ru/f6ae3fb2-d004-ec11-812165468468.pdf",
"segment": "west",
"cdc_city": "Красное Село",
"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": "Готовые завтраки"
},
{
"target": 117,
"kpi_cid": "PS/Home Shelf/Golden Sku",
"category": "Корм для животных"
},
{
"target": 28,
"kpi_cid": "PS/Home Shelf/Other Sku",
"category": "Корм для животных"
},
{
"target": 10,
"kpi_cid": "PS/Home Shelf/Multi Facing",
"category": "Корм для животных"
},
{
"target": 5,
"kpi_cid": "PS/Home Shelf/Multi Facing",
"category": "Кулинария"
}
],
"brand_code": 1303,
"brand_name": "X5 Retail Group",
"cdc_region": "Санкт-Петербург",
"cdc_street": "Стрельнинское",
"mml_matrix": null,
"short_name": "BR20 X5 Пятерочка Санкт-Петербург Стрельнинское 4",
"banner_code": 4656,
"banner_name": "Пятерочка (Прямая)",
"cdc_country": "Россия",
"format_name": "BR20",
"list_matrix": 200931,
"stream_name": "Федеральные Сети",
"MATRIX_NAMES": {
"Total": null,
"Кофе": "WCh X5 Пятерочка СевЗап Better 20 Кофе_2771",
"Кулинария": "WCh X5 Пятерочка СевЗап Better 20 Магги_2773",
},
"SM_link_xlsx": "https://xcrm.s3.dtln.ru/f6ae3fb2-d004-ec11-8121-65468464548.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": {
"Кофе": {
"standard": "...",
"started_at": "2021-05-01",
"standard_plus": "..."
},
"Кулинария": {
"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": "г Санкт-Петербург, г Красное Село, ш Стрельнинское, д 4",
"inout_products_matrix": null,
"status_normalize_code": 0,
"status_normalize_name": "Точные координаты",
"assort_matrix_bistroff": 191336,
"assort_matrix_kulinary": 648362,
"assort_matrix_nutrition": 191331,
"assort_matrix_confectionery": 648348
},
"description": " <h2>Оглавление</h2> <ul> <li><a href=#assortment>Ассортимент</a></li> <li><a href=#in_out_and_new_products>In-Out и новинки</a></li> <li><a href=#merch_standards>Стандарты мерчандайзинга</a></li> <li><a href=#promo>Промо</a></li> <li><a href=#popm>POPM</a></li> </ul>...",
"retail_chain": 23,
"logo": 81679447,
"store_type": 6,
"group": null,
"agent_routes": [
3645,
6823,
7209
]
}
...
]
}

Response definitions


count integer

Required. Number of stores.

next string (uri) Nullable

Next page.


previous string (uri) Nullable

Previous page.


results Array of objects

Required. Array of objects with information about stores.

id integer

Store ID.


route string <= 255 characters Nullable

Agent route.


route_type_description string <= 255 characters Nullable

Route type description.


customer_id string <= 255 characters Nullable

Customer ID.


customer_name string <= 255 characters Nullable

Customer name.


region string <= 255 characters Nullable

The region where the point of sale is located.


region_l3 string <= 255 characters Nullable


region_l4 string <= 255 characters Nullable


area string <= 255 characters Nullable


area_l5 string <= 255 characters Nullable


area_l6 string <= 255 characters Nullable


city string <= 255 characters Nullable

The city where the point of sale is located.


sales_route_id string <= 255 characters Nullable

Sales route ID.


latitude string Nullable

Coordinates of the point of sale by latitude.


longitude string Nullable

Coordinates of the point of sale by longitude.


created_at string (date-time)

Date and time of creation in the format «YYYY-MM-DDTHH:MM:SSZ».


updated_at string (date-time)

Date and time of data update in the format «YYYY-MM-DDTHH:MM:SSZ».


address string <= 255 characters Nullable

Store address.


distr_name string <= 255 characters Nullable

Name of the district where the store is located.


team_id string <= 255 characters Nullable


rsm_name string <= 255 characters Nullable


rsm_code string <= 255 characters Nullable


tsm_name string <= 255 characters Nullable


route_type_full string <= 255 characters Nullable


segment string <= 255 characters Nullable


pos_code string <= 255 characters Nullable


matrix_name string <= 255 characters Nullable


id_dealer string <= 255 characters Nullable


golden_id string <= 255 characters Nullable


sector string <= 255 characters Nullable


manager string <= 255 characters Nullable


inn string <= 255 characters Nullable


kpp string <= 255 characters Nullable


sale_channel string <= 255 characters Nullable


country string <= 255 characters Nullable


fss string <= 255 characters Nullable


fss_code string <= 255 characters Nullable


sfss string <= 255 characters Nullable


sfss_code string <= 255 characters Nullable


em string <= 255 characters Nullable


em_code string <= 255 characters Nullable


agency string <= 255 characters Nullable


agency_region string <= 255 characters Nullable


kam_food string <= 255 characters Nullable


kam_food_code string <= 255 characters Nullable


kam_hpc string <= 255 characters Nullable


kam_hpc_code string <= 255 characters Nullable


ctl string <= 255 characters Nullable


ctl_code string <= 255 characters Nullable


mte string <= 255 characters Nullable


mte_code string <= 255 characters Nullable


nsd string <= 255 characters Nullable


nsd_code string <= 255 characters Nullable


visit_plan_id string <= 255 characters Nullable


driver_id string <= 255 characters Nullable


sap_code string <= 255 characters Nullable


sales_group string <= 255 characters Nullable


visit_type string <= 255 characters Nullable


hierarchy_l5 string <= 255 characters Nullable


hierarchy_l6 string <= 255 characters Nullable


visit_frequency string <= 255 characters Nullable


dsd_distr string <= 255 characters Nullable


store_number string <= 255 characters Nullable


virtual_flag string <= 255 characters Nullable


lka_segment string <= 255 characters Nullable


customer_segment string <= 255 characters Nullable


y_cust_hier_level_6 string <= 255 characters Nullable


y_cust_hier_level_8 string <= 255 characters Nullable


store_format string <= 255 characters Nullable


team_route string <= 255 characters Nullable


route_type_dsd string <= 255 characters Nullable


route_merch string <= 255 characters Nullable


service_type string <= 255 characters Nullable


svm string <= 255 characters Nullable


tm string <= 255 characters Nullable


rmm string <= 255 characters Nullable


kam_ekam string <= 255 characters Nullable


skam string <= 255 characters Nullable


days_sequence_code string <= 255 characters Nullable


weekly_frequency string <= 255 characters Nullable


bm string <= 255 characters Nullable


sv string <= 255 characters Nullable


se string <= 255 characters Nullable


task_type string <= 255 characters Nullable


task_subtype string <= 255 characters Nullable


enabled boolean


week_days string <= 255 characters Nullable


uuid string Nullable


global_channel string <= 255 characters Nullable


sync_point string <= 255 characters Nullable


master_code string <= 255 characters Nullable


dt string <= 255 characters Nullable


svme string <= 255 characters Nullable


me string <= 255 characters Nullable


description_toloka string <= 255 characters Nullable


visits_per_month string Nullable


supervisor_code string <= 255 characters Nullable


ka_dt string <= 255 characters Nullable


svme_code string <= 255 characters Nullable


svme_email string <= 255 characters Nullable


me_code string <= 255 characters Nullable


json object Nullable


description string Nullable


retail_chain integer Nullable


logo integer Nullable


store_type integer Nullable


group integer Nullable


agent_routes Array of integers