Visits
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.
GET /visits
Retrieve a list of visits.
Response parameters
count integer
The number of visits.
next string (uri) Nullable
Next page.
previous string (uri) Nullable
Previous page.
results array 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
POST /visits
Сreate a new visit.
GET /visits/{id}
Retrieve detailed information about a visit by ID.
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
PUT /visits/{id}
Update all fields of visit.
PATCH /visits/{id}
Update some of the visit fields.