Location Booking Dispatch Payload

Request

Payload for sending location booking dispatches.

By default, we send our standard LocationDispatchOutput schema, but the body can also be a custom mapped format.

Bodyapplication/jsonrequired

Any of:

operationstring(BookingOperation)required

Enum:"CREATE""UPDATE""CANCEL"

payloadobject(LocationDispatchPayload)required

POST

https://<location-booking-receiving-endpoint>

{
  "operation": "CREATE",
  "payload": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "orders": [ … ],
    "scenario": "INBOUND",
    "booking": { … },
    "trip_summary": { … }
  }
}

Responses

Successful Response

Bodyapplication/json

Any of:

Response schema for the location booking dispatch payload. This schema is used to return errors or success messages.

errorsArray of objects or null(Errors)

Any of:

List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.

Response

{
  "errors": {
    "error_message": "The payload is invalid.",
    "error_type": "USER_INPUT_ERROR"
  }
}