Reservation Simulation

PATCH 
https://api.lochting.com/public/v1/reservation/:reservationId/simulate-status-change

This endpoint enables authorized users to simulate a reservation status change. This endpoint is only available on the DEV environment. Valid transitions are:

• created
  • => incomplete
  • => complete
  • => canceled
  • => robotReservationFailed
• incomplete
  • => complete
  • => canceled
• complete
  • => deliveryRequested
  • => deliveryRequestFailed
  • => canceled
• deliveryRequested
  • => delivered
  • => deliveryFailed
• delivered
  • => pickedUp
  • => pickUpFailed

Request

Path Parameters

reservationId stringrequired
The id of the reservation.
Example: reservation-c7d932c1-84e8-410c-a9b2-18bf739d6b8b

Header Parameters

Authorization stringrequired
Example: your-access-token

application/json

Bodyrequired

statusReservationStatus (string)required
The reservation status
Possible values: [incomplete, complete, robotReservationFailed, deliveryRequested, deliveryRequestFailed, delivered, deliveryFailed, pickedUp, pickUpFailed, canceled]
Example: incomplete

Responses

200

OK

401

Unauthorized

404

Not Found

application/json

Schema

Schema

messagestring
Example: Reservation not found: reservation-c7d932c1-84e8-410c-a9b2-18bf739d6b8b

Example (auto)

{
  "message": "Reservation not found: reservation-c7d932c1-84e8-410c-a9b2-18bf739d6b8b"
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.lochting.com/public/v1/reservation/:reservationId/simulate-status-change");
var content = new StringContent("{\n  \"status\": \"incomplete\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.lochting.com/public/v1

Parameters

reservationId — pathrequired

Authorization — headerrequired

Body required

{
  "status": "incomplete"
}

ResponseClear

Click the Send API Request button above and see the response here!