v1

latestOpenAPI 3.0.02026-08-04265791.1 MB

Visits

Partial Update

Update a subset of properties of a visit

patch/public/api/visits/{id}

Path parameters

idstring required

The id of the visit

Headers

Acceptstring

e.g. application/json

Response

visit_idstring

typestring

descriptionstring

user_idstring

creator_idstring

store_idstring

visit_datestring

start_timestring

end_timestring

compliantboolean

Example response

{
  "visit_id": "54ab03c6546847ee0d30084a",
  "type": "stocktaking",
  "description": "Approved store visit.",
  "user_id": "5d160d2486191e003b3e538b",
  "creator_id": "5d160d2486191e003b3e538b",
  "store_id": "5d160a327411ab005c986216",
  "visit_date": "2019-09-04T00:00:00.000Z",
  "start_time": "17:00",
  "end_time": "18:30",
  "compliant": true
}