Sign in
latestOpenAPI 3.0.12026-08-15202774.6 KB

cdae4166b346

Bookings

Update a booking

Updates an existing booking. All fields are optional.

You can update any combination of fields independently, or provide a complete replacement for specific sections like arrival windows or customer details.

To update arrival windows, provide either arrival_window_id from the schedules endpoint or a custom future ISO 8601 arrival_window_from. arrival_window_to is optional and defaults to one hour after arrival_window_from. Updates can fail if the requested window cannot be reserved.

customer is optional and organization-only.

patch/bookings/{id}

Request body

OR
OR

Example request

{
  "origin": "123e4567-e89b-12d3-a456-426614174000",
  "destination": "123e4567-e89b-12d3-a456-426614174000",
  "customer": {
    "name": "John Doe",
    "email": "john@example.com",
    "phone_number": "+14155551234"
  },
  "contacts": [
    {
      "name": "Store Team",
      "phone_number": "+14155550100",
      "email": "store@example.com",
      "stop_positions": [
        0
      ]
    }
  ]
}

Response

OK