Report bot status

{
  "success": true,
  "data": {
    "reservation": {
      "reservation_id": "string",
      "status": "requested",
      "zone_id": "string",
      "stall_id": "string",
      "stall_label": "string",
      "retailer_id": "string",
      "order_number": "string",
      "end_user_name": "string",
      "end_user_phone": "+15125550123",
      "arrival_window_start": "2024-01-15T09:30:00Z",
      "arrival_window_end": "2024-01-15T09:30:00Z",
      "open_link_url": "string",
      "canceled_by": "string",
      "cancel_reason": "string",
      "retailer_pickup_ref": "string",
      "payload_limit": {
        "max_weight_kg": 1.1,
        "max_dimensions_cm": {
          "length": 1.1,
          "width": 1.1,
          "height": 1.1
        }
      },
      "bot": {
        "status": "INBOUND",
        "label": "string",
        "eta": "2024-01-15T09:30:00Z",
        "asserted_at": "2024-01-15T09:30:00Z"
      },
      "handoff": {
        "status": "QUEUED",
        "task_started_at": "2024-01-15T09:30:00Z",
        "order_in_hand_at": "2024-01-15T09:30:00Z",
        "ready_estimate": "2024-01-15T09:30:00Z",
        "runner_at_unit_at": "2024-01-15T09:30:00Z",
        "handoff_completed_at": "2024-01-15T09:30:00Z",
        "load_photo_url": "string",
        "load_photo_skipped": true,
        "runner_delay_seconds": 1
      },
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  }
}

Reports where your bot is for this reservation. Statuses move forward only (INBOUND, ARRIVED, READY_FOR_HANDOFF, SECURED, DEPARTED; any may be skipped); ABORTED is accepted before SECURED and is final. Repeating the current status is a 200 and still updates label and eta. A status behind the current one is 409 BOT_STATUS_REGRESSION. On a completed or canceled reservation only a repeat is accepted; anything else is 409 INVALID_STATE.

Side effects land in the same transaction as the report and fire the matching webhooks: ARRIVED or later marks a confirmed reservation arrived; READY_FOR_HANDOFF opens the handoff for a runner waiting at your bot; SECURED ends the runner’s task (loaded if the compartment was opened, otherwise the order goes back to the counter; an open still in flight is waited for); DEPARTED completes the reservation; ABORTED flags or fails the runner’s task and leaves the reservation open until you cancel it or its window expires. The status table in the Reservations guide has the per-status detail.

Authentication

AuthorizationBearer

API key generated in the Autolane Portal. Keys are organization-scoped, carry granular permissions, and are environment-specific: a sandbox key only works against the sandbox host, and a production key only against the production host.

Path parameters

idstringRequiredformat: "uuid"

Reservation id

Request

This endpoint expects an object.

statusenumRequired

Forward only, in this order: INBOUND, ARRIVED, READY_FOR_HANDOFF, SECURED, DEPARTED. ABORTED is accepted from any status before SECURED and is final.

labelstringOptional1-64 characters

Your identifier for the bot, shown to the runner; updated on every accepted report

etadatetimeOptional

When the bot expects to reach the stall (RFC 3339 with offset). Must be within 24 hours of now on either side (a deployment default, tunable per environment); re-anchors the runner's staging time while no runner has been dispatched

occurred_atdatetimeOptional

When the status became true on your side (RFC 3339 with offset). Defaults to now; may not be more than five minutes in the future

reasonstringOptional1-256 characters

Free text for ABORTED, recorded with the task exception

Response

The reservation with its updated bot block (and handoff block, if the report moved the runner's task)

successboolean

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error