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.
﻿
Retrieve a list of visits.
GET /visits
GET
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
limit
optional
String
The number of results to return per page.
offset
optional
String
The initial index from which to return the results.
﻿
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
﻿
﻿
﻿
Сreate a new visit.
POST /sku
POST
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
Visit ID.
shop
optional
String
Client-specific customer/outlet/shop/... ID.
agent
optional
String
Client-specific agent name/id/route/...
started_date
optional
String
Date and time of the visit start (UTC time). To create a visit, expect a date in the format «YYYY-MM-DDTHH:MM:SSZ».
latitude
optional
Integer
Location of the merchandiser at the time of the visit by latitude.
longitude
optional
String
Location of the merchandiser at the time of the visit by longitude.
﻿
﻿
Retrieve detailed information about a visit by ID.
GET /visits/{id}
GET
Request
Path Params
id
required
String
Visit ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
﻿
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
﻿
﻿
﻿
Update all fields of visit.
PUT /visits/{id}
PUT
Request
Path Params
id
required
String
SKU ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
﻿
﻿
Update some of the visit fields.
PATCH /visits/{id}
PATCH
Request
Path Params
id
required
String
SKU ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
SKU ID.
cid
optional
String
Client-specific SKU ID, e.g. internal code.
ean13
optional
String
European Article Number.
image
optional
String
SKU image ID, available via /uploads or /uploads_by_url.
name
optional
String
Human readable SKU name.
brand
optional
String
Brand ID.
category
optional
String
Category ID.
manufacturer
optional
String
Manufacturer ID.
size_x_mm
optional
Integer
Product width in mm.
size_y_mm
optional
Integer
Product height in mm.
size_z_mm
optional
Integer
Product depth in mm.
﻿
﻿
﻿
Updated 03 Mar 2023
Did this page help you?
Displays
MHL
Visits

﻿GET /visits

Response parameters​﻿

﻿POST /visits

﻿GET /visits/{id}

Response parameters

﻿PUT /visits/{id}

﻿PATCH /visits/{id}

GET /visits

Response parameters

POST /visits

GET /visits/{id}

PUT /visits/{id}

PATCH /visits/{id}
