---
title: Visits
slug: kqPX-visits
docTags:
createdAt: 2022-04-13T09:34:57.000Z
---
Methods allow you to get a complete list or a specific visit in Eyrene, view information about them, update all fields, or only select visit fields.
***
::::ExpandableHeading
# GET /visits
Retrieve a list of visits.
:::ApiMethodV2
```json
{
"tab": "request",
"url": "https://instance_name/api/v1.5/visits/",
"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": "string",
"description": "The number of results to return per page."
},
{
"kind": "optional",
"name": "offset",
"type": "string",
"description": "The initial index from which to return the results."
}
],
"formDataParameters": []
},
"results": {
"languages": [
{
"id": "1rlkLKO5JlhTk3S80Ce0g",
"code": "{\n \"count\":1,\n \"next\":\"http://example.com\",\n \"previous\":null,\n \"results\":[\n {\n \"id\":2323,\n \"shop\":\"1504553224092\",\n \"agent\":\"agent\",\n \"started_date\":\"2020-07-27T18:35:46.586695Z\",\n \"task\":null,\n \"latitude\":53.7356226,\n \"longitude\":91.4279673,\n \"shop_name\":\"The one with ondemand task groups\",\n \"shop_area\":null,\n \"gps_shop\":{\n \"id\":5316,\n \"logo\":null,\n \"route\":\"939-EAH\",\n \"route_type_description\":null,\n \"customer_id\":\"1504553224092\",\n \"customer_name\":\"The one with ondemand task groups\",\n \"region\":\"South Ashley\",\n \"region_l3\":null,\n \"region_l4\":null,\n \"area\":null,\n \"area_l5\":null,\n \"area_l6\":null,\n \"city\":\"Garrisonfurt\",\n \"sales_route_id\":null,\n \"latitude\":-45.5718055,\n \"longitude\":110.701806,\n \"created_at\":\"2020-06-29T15:24:18.290885Z\",\n \"updated_at\":\"2021-10-08T08:16:02.513126Z\",\n \"address\":\"51805 James StreamWilliamsview, NM 65300\",\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\":null,\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\":\"Somalia\",\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\":null,\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\":\"5be684a7-7fd8-4256-92cc-b8d50e279a20\",\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 \"RAR\":16,\n \"WAV\":17,\n \"attr\":\"Test value\"\n },\n \"description\":\"Stop again across. Arrive across develop address across. Business suffer responsibility choice rich account involve.\",\n \"retail_chain\":5,\n \"store_type\":null,\n \"group\":null,\n \"agent_routes\":[\n \n ]\n },\n \"images\":[\n {\n \"12859\":\"https://test.inspector-cloud.com/media/2020/07/27/b42e4d19-05aa-4485-8141-4bb59775fce8.jpg\"\n }\n ],\n \"current_agent_name\":\"agent\",\n \"current_agent_route\":\"staging\",\n \"moderation\":null,\n \"results\":{\n \"id\":25314,\n \"status\":\"POSITIVE\",\n \"update_type\":\"VISIT RESULTS\",\n \"message_type\":\"TEXT\",\n \"message\":\" Количество обработанных кассовых узлов: 5 из 3
...\",\n \"created_date\":\"2020-07-27T18:43:13.624437Z\",\n \"updated_at\":\"2020-07-27T18:43:13.624482Z\",\n \"message_short\":null,\n \"agent\":864,\n \"visit\":2323,\n \"scene\":null\n },\n \"helpdesk\":null\n }\n ]\n}",
"language": "200",
"customLabel": ""
}
],
"selectedLanguageId": "1rlkLKO5JlhTk3S80Ce0g"
},
"examples": {
"languages": [
{
"id": "Cu1xhLxZ5PHAuLFx_iIf1",
"code": "curl –i –X GET\r\n https://test.eyrene.com/api/v1.5/sku/\r\n -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ \r\n –F \"limit=1\" \\\r\n –F \"offset=0\" ",
"language": "curl",
"customLabel": ""
}
],
"selectedLanguageId": "Cu1xhLxZ5PHAuLFx_iIf1"
},
"description": "GET /visits",
"currentNewParameter": {
"label": "Body Parameter",
"value": "bodyDataParameters"
},
"autoGeneratedAnchorSlug": "request-example",
"legacyHash": "W3aH_9WiAxtTGXs8jqnTM"
}
```
:::
## Response parameters[](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/catalog/brands#response-definitions)
***
`count` *integer*
The number of visits.
***
`next` *string (uri)* *Nullable***
Next page.
***
`previous` *string (uri)* *Nullable***
Previous page.
***
`results` a*rray of objects*
An array of objects with information about visits:
- `id` *string*
Visit ID.
- `shop` *string*
Shop ID.
- `agent` *string*
The agent who performs the visit.
- `started_date` *string (date-time)*
Date and time of the start of the visit (UTC) in the format «YYYY-MM-DDTHH\:MM\:SSZ».
- `task` *string*
- `latitude` *float*
The coordinates of the merchandiser during the visit. Width
- `longitude` *float*
The coordinates of the merchandiser during the visit. Longitude
- `shop_name` *string*
- `shop_area` *string*
- `gps_shop` *array of objects*
* *An array with information about the point of sale where the visit takes place.
- `images` *array of objects*
* *Photos the visit.
- `current_agent_name` *string*
- `current_agent_route` *string*
- `moderation` *string*
- `results` *array of objects*
Visit results.
- `id` *string*
- `status` *string*
- `update_type` *string*
- `message_type` *string*
The data type in which the result is output.
- `message` *text*
Information about the results of the visit.
- `helpdesk` *string*
***
::::
***
::::ExpandableHeading
# POST /visits
Сreate a new visit.
:::ApiMethodV2
```json
{
"tab": "request",
"url": "https://instance_name/api/v1.5/visits/",
"name": "Request example",
"method": "POST",
"request": {
"pathParameters": [],
"queryParameters": [],
"headerParameters": [
{
"kind": "required",
"name": "Authorization",
"type": "string",
"description": "String in \"Token XXXXXX...\" format."
}
],
"bodyDataParameters": [
{
"kind": "optional",
"name": "id",
"type": "string",
"description": "Visit ID."
},
{
"kind": "optional",
"name": "shop",
"type": "string",
"description": "Client-specific customer/outlet/shop/... ID."
},
{
"kind": "optional",
"name": "agent",
"type": "string",
"description": "Client-specific agent name/id/route/..."
},
{
"kind": "optional",
"name": "started_date",
"type": "string",
"description": "Date and time of the visit start (UTC time). To create a visit, expect a date in the format «YYYY-MM-DDTHH:MM:SSZ»."
},
{
"kind": "optional",
"name": "latitude",
"type": "Integer",
"description": "Location of the merchandiser at the time of the visit by latitude."
},
{
"kind": "optional",
"name": "longitude",
"type": "string",
"description": "Location of the merchandiser at the time of the visit by longitude."
}
],
"formDataParameters": []
},
"results": {
"languages": [
{
"id": "xcVqafQ2RCx_iOpUkQJ43",
"code": "{\n \"result\": \"CREATED\"\n}",
"language": "201",
"customLabel": ""
}
],
"selectedLanguageId": "xcVqafQ2RCx_iOpUkQJ43"
},
"examples": {
"languages": [
{
"id": "Cu1xhLxZ5PHAuLFx_iIf1",
"code": "curl –i –X POST\r\n https://test.eyrene.com/api/v1.5/sku/ \r\n -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ \r\n -F \"id=2323\" \\ \r\n -F \"shop=1504553224092\" \\\r\n -F \"agent=alex\"\r\n ...",
"language": "curl",
"customLabel": ""
}
],
"selectedLanguageId": "Cu1xhLxZ5PHAuLFx_iIf1"
},
"description": "POST /sku",
"currentNewParameter": {
"label": "Body Parameter",
"value": "bodyDataParameters"
},
"autoGeneratedAnchorSlug": "request-example-1",
"legacyHash": "yxLHVXhsxNW1-OHt8NSwp"
}
```
:::
::::
***
::::ExpandableHeading
# GET /visits/\{id}
Retrieve detailed information about a visit by ID.
:::ApiMethodV2
```json
{
"tab": "request",
"url": "https://instance_name/api/v1.5/visits/{id}",
"name": "Request example",
"method": "GET",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "id",
"type": "string",
"description": "Visit ID."
}
],
"queryParameters": [],
"headerParameters": [
{
"kind": "required",
"name": "Authorization",
"type": "string",
"description": "String in \"Token XXXXXX...\" format."
}
],
"bodyDataParameters": [],
"formDataParameters": []
},
"results": {
"languages": [
{
"id": "BcmDi-d9UM-V1Lp9EpJ4I",
"code": "{\n \"id\":2032,\n \"shop\":\"1504553224092\",\n \"agent\":\"agent\",\n \"started_date\":\"2020-07-27T18:35:46.586695Z\",\n \"task\":null,\n \"latitude\":53.7356226,\n \"longitude\":91.4279673,\n \"shop_name\":\"The one with ondemand task groups\",\n \"shop_area\":null,\n \"gps_shop\":{\n \"id\":5316,\n \"logo\":null,\n \"route\":\"939-EAH\",\n \"route_type_description\":null,\n \"customer_id\":\"1504553224092\",\n \"customer_name\":\"The one with ondemand task groups\",\n \"region\":\"South Ashley\",\n \"region_l3\":null,\n \"region_l4\":null,\n \"area\":null,\n \"area_l5\":null,\n \"area_l6\":null,\n \"city\":\"Garrisonfurt\",\n \"sales_route_id\":null,\n \"latitude\":-45.5718055,\n \"longitude\":110.701806,\n \"created_at\":\"2020-06-29T15:24:18.290885Z\",\n \"updated_at\":\"2021-10-08T08:16:02.513126Z\",\n \"address\":\"51805 James StreamWilliamsview, NM 65300\",\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\":null,\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\":\"Somalia\",\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\":null,\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\":\"5be684a7-7fd8-4256-92cc-b8d50e279a\",\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 \"RAR\":16,\n \"WAV\":17,\n \"attr\":\"Test value\"\n },\n \"description\":\"Stop again across.\",\n \"retail_chain\":5,\n \"store_type\":null,\n \"group\":null,\n \"agent_routes\":[\n \n ]\n },\n \"images\":[\n \"..\"\n ],\n \"current_agent_name\":\"agent\",\n \"current_agent_route\":\"staging\",\n \"moderation\":null,\n \"results\":{\n \"..\"\n },\n \"helpdesk\":null\n}",
"language": "200",
"customLabel": ""
}
],
"selectedLanguageId": "BcmDi-d9UM-V1Lp9EpJ4I"
},
"examples": {
"languages": [
{
"id": "Cu1xhLxZ5PHAuLFx_iIf1",
"code": "curl –i –X GET\r\n https://test.eyrene.com/api/v1.5/visits/2032/ \r\n -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ ",
"language": "curl",
"customLabel": ""
}
],
"selectedLanguageId": "Cu1xhLxZ5PHAuLFx_iIf1"
},
"description": "GET /visits/{id}",
"currentNewParameter": {
"label": "Path Parameter",
"value": "pathParameters"
},
"autoGeneratedAnchorSlug": "request-example-2",
"legacyHash": "xnq0yV2NanKEln_i2DR1N"
}
```
:::
## Response parameters
***
`id` *string*
Visit ID.
***
`shop` *string*
Shop ID.
***
`agent` *string*
The agent who performs the visit.
***
`started_date` *string (date-time)*
Date and time of the start of the visit (UTC) in the format «YYYY-MM-DDTHH\:MM\:SSZ».
***
`task` *string*
***
`latitude` *float*
The coordinates of the merchandiser during the visit. Width
***
`longitude` *float*
The coordinates of the merchandiser during the visit. Longitude
***
`shop_name` *string*
***
`shop_area` *string*
***
`gps_shop` *array of objects*
An array of information about the point of sale where the visit takes place.
***
`images` *array of objects*
Photos in the visit.
***
`current_agent_name` *string*
***
`current_agent_route` *string*
***
`moderation` *string*
***
`results` *array of objects*
Visit results.
***
`helpdesk` *string*
***
[](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/catalog/brands_id#response-definitions)
::::
***
::::ExpandableHeading
# PUT /visits/\{id}
Update all fields of visit.
:::ApiMethodV2
```json
{
"tab": "request",
"url": "https://instance_name/api/v1.5/visits/{id}",
"name": "Request example",
"method": "PUT",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "id",
"type": "string",
"description": "SKU ID."
}
],
"queryParameters": [],
"headerParameters": [
{
"kind": "required",
"name": "Authorization",
"type": "string",
"description": "String in \"Token XXXXXX...\" format."
}
],
"bodyDataParameters": [],
"formDataParameters": []
},
"results": {
"languages": [
{
"id": "BcmDi-d9UM-V1Lp9EpJ4I",
"code": "{\n \"id\":9846,\n \"shop\":\"1504553224092\",\n \"agent\":\"agent\",\n \"started_date\":\"2020-07-27T18:35:46.586695Z\",\n \"task\":null,\n \"latitude\":53.7356226,\n \"longitude\":91.4279673,\n \"shop_name\":\"The one with ondemand task groups\",\n \"shop_area\":null,\n \"gps_shop\":{\n \"..\"\n },\n \"images\":[\n \"..\"\n ],\n \"current_agent_name\":\"agent\",\n \"current_agent_route\":\"staging\",\n \"moderation\":null,\n \"results\":{\n \"..\"\n },\n \"helpdesk\":null\n}",
"language": "200",
"customLabel": ""
}
],
"selectedLanguageId": "BcmDi-d9UM-V1Lp9EpJ4I"
},
"examples": {
"languages": [
{
"id": "Cu1xhLxZ5PHAuLFx_iIf1",
"code": "curl –i –X PUT\r\n https://test.eyrene.com/api/v1.5/visits/2032/ \r\n -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’\r\n -F \"id=9846\"\r\n ...",
"language": "curl",
"customLabel": ""
}
],
"selectedLanguageId": "Cu1xhLxZ5PHAuLFx_iIf1"
},
"description": "PUT /visits/{id}",
"currentNewParameter": {
"label": "Body Parameter",
"value": "bodyDataParameters"
},
"autoGeneratedAnchorSlug": "request-example-3",
"legacyHash": "BHwiEpOmrs1otrmqCzZ7J"
}
```
:::
::::
***
::::ExpandableHeading
# PATCH /visits/\{id}
Update some of the visit fields.
:::ApiMethodV2
```json
{
"tab": "request",
"url": "https://instance_name/api/v1.5/visits/{id}",
"name": "Request example",
"method": "PATCH",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "id",
"type": "string",
"description": "SKU ID."
}
],
"queryParameters": [],
"headerParameters": [
{
"kind": "required",
"name": "Authorization",
"type": "string",
"description": "String in \"Token XXXXXX...\" format."
}
],
"bodyDataParameters": [
{
"kind": "optional",
"name": "id",
"type": "string",
"description": "SKU ID."
},
{
"kind": "optional",
"name": "cid",
"type": "string",
"description": "Client-specific SKU ID, e.g. internal code."
},
{
"kind": "optional",
"name": "ean13",
"type": "string",
"description": "European Article Number."
},
{
"kind": "optional",
"name": "image",
"type": "string",
"description": "SKU image ID, available via /uploads or /uploads_by_url."
},
{
"kind": "optional",
"name": "name",
"type": "string",
"description": "Human readable SKU name."
},
{
"kind": "optional",
"name": "brand",
"type": "string",
"description": "Brand ID."
},
{
"kind": "optional",
"name": "category",
"type": "string",
"description": "Category ID."
},
{
"kind": "optional",
"name": "manufacturer",
"type": "string",
"description": "Manufacturer ID."
},
{
"kind": "optional",
"name": "size_x_mm",
"type": "Integer",
"description": "Product width in mm."
},
{
"kind": "optional",
"name": "size_y_mm",
"type": "Integer",
"description": "Product height in mm."
},
{
"kind": "optional",
"name": "size_z_mm",
"type": "Integer",
"description": "Product depth in mm."
}
],
"formDataParameters": []
},
"results": {
"languages": [
{
"id": "BcmDi-d9UM-V1Lp9EpJ4I",
"code": "{\n \"id\":9846,\n \"shop\":\"1504553224\",\n \"agent\":\"agent\",\n \"started_date\":\"2020-07-27T18:35:46.586695Z\",\n \"task\":null,\n \"latitude\":53.7356226,\n \"longitude\":91.4279673,\n \"shop_name\":\"The one with ondemand task groups\",\n \"shop_area\":null,\n \"gps_shop\":{\n \"..\"\n },\n \"images\":[\n \"..\"\n ],\n \"current_agent_name\":\"agent\",\n \"current_agent_route\":\"staging\",\n \"moderation\":null,\n \"results\":{\n \"..\"\n },\n \"helpdesk\":null\n}",
"language": "200",
"customLabel": ""
}
],
"selectedLanguageId": "BcmDi-d9UM-V1Lp9EpJ4I"
},
"examples": {
"languages": [
{
"id": "Cu1xhLxZ5PHAuLFx_iIf1",
"code": "curl –i –X PATCH\r\n https://test.eyrene.com/api/v1.5/sku/2032/ \r\n -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’\r\n -F \"id=9846\" \\\r\n -F \"shop=1504553224\"",
"language": "curl",
"customLabel": ""
}
],
"selectedLanguageId": "Cu1xhLxZ5PHAuLFx_iIf1"
},
"description": "PATCH /visits/{id}",
"currentNewParameter": {
"label": "Body Parameter",
"value": "bodyDataParameters"
},
"autoGeneratedAnchorSlug": "request-example-4",
"legacyHash": "m6ahIEae3_lmero7zEl9C"
}
```
:::
::::
***