Book Shipment
bookBook a quoted shipment using any quote_id or option id returned from a quote tool (Warp or market carrier). Requires quote_id and the full delivery address with the delivery contact's name, phone and email, every time. Pickup can be omitted only when a default shipper is saved on the account. Collect any missing delivery details from the user BEFORE calling. Auth required.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | No | Special instructions for the shipment | |
| pickup | No | Pickup address. Required if no default shipper is saved on your account. | |
| delivery | Yes | Delivery address and delivery contact. Required on every booking, with every field: street, city, state, ZIP, contact name, phone and email. Warp never fills delivery from past shipments. Ask the user for anything missing before calling book. | |
| quote_id | Yes | Quote ID from warp_quote_id (Warp) or id field of any market option returned by a quote tool. Use the id from your MOST RECENT quote — market-option ids rotate on every quote call and stale ids are rejected. | |
| reference | No | Your internal reference number | |
| accessorials | No | Pickup/delivery accessorial services. Should match the accessorials used when quoting. | |
| pickup_window | No | Pickup time window, 24h HH:MM, e.g. { from: '08:00', to: '17:00' }. Defaults to a full business day if omitted. | |
| delivery_window | No | Delivery time window, 24h HH:MM, e.g. { from: '09:00', to: '12:00' }. Defaults to a full business day if omitted. |