v1

latestOpenAPI 3.0.02026-08-04265791.1 MB

Visits

Get

Get a visit for the given id.

get/public/api/visits/{id}

Path parameters

idstring required

The id of the visit

Headers

Acceptstring

e.g. application/json

Response

visit_idstring

typestring

descriptionstring

visit_datestring

start_timestring

Example response

{
  "visit_id": "54ab03c6546847ee0d30084a",
  "type": "stocktaking",
  "description": "scheduled store visit",
  "visit_date": "2019-09-04T00:00:00.000Z",
  "start_time": "17:00"
}