API
Data API
Stores
methods allow you to get a list of portal stores or information on a specific store get get /stores return a list of stores { "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" } } get get /stores/{id} returns information about store by id { "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" } }