Quickstart
1
Install the WARP CLI
Requires Node.js 18+ for npm, or use Homebrew for a standalone binary.
terminal
npm install -g @wearewarp.com/cliVerify the installation:
terminal
warp --version2
Authenticate
Log in with your API key or via browser. Get your key from the API settings page.
terminal
warp login --api-key YOUR_API_KEYOr authenticate via browser:
terminal
warp login --browser3
Get a freight quote
Request an instant shipping quote with origin, destination, and item details.
terminal
warp quote \
--pickup-date 2026-04-01 \
--pickup-zip 90210 \
--delivery-zip 10001 \
--item-height 48 --item-length 48 --item-width 40 \
--item-size-unit IN \
--item-weight 500 --item-weight-unit lbs \
--item-qty 1 \
--shipment-type LTLResponse:
json
{
"quote_id": "59120da4-c844-4502-a468-cca8e4018bd5",
"price": { "amount": 1000, "currency_code": "USD" },
"status": "ACCEPT",
"shipmentType": "LTL"
}4
Book the shipment
Use the quote ID from step 3 to book. Pass details inline or via a JSON file.
terminal
warp book --quote-id <QUOTE_ID> --from-file booking.jsonExample booking.json:
booking.json
{
"pickupInfo": {
"contactName": "John Smith",
"contactPhone": "555-0100",
"address": {
"street": "123 Warehouse Ave",
"city": "Los Angeles",
"state": "CA",
"zipcode": "90210"
},
"windowTime": {
"from": "2026-04-01T08:00:00Z",
"to": "2026-04-01T17:00:00Z"
},
"instructions": "Dock 3, call on arrival"
},
"deliveryInfo": {
"contactName": "Jane Doe",
"contactPhone": "555-0200",
"address": {
"street": "456 Distribution Blvd",
"city": "New York",
"state": "NY",
"zipcode": "10001"
},
"windowTime": {
"from": "2026-04-05T08:00:00Z",
"to": "2026-04-05T17:00:00Z"
}
},
"refNum": "PO-2026-001"
}5
Track your shipment
Monitor any shipment in real time.
terminal
warp track WARP-1234567List all shipments:
terminal
warp shipments -o jsonCommand reference
warp quoteRequest a shipping quotewarp quote --from-file quote.json -o jsonwarp bookBook a shipment from a quotewarp book --quote-id <ID> --from-file booking.jsonwarp trackTrack shipments by numberwarp track WARP-1234567,WARP-7654321warp shipmentsList all shipmentswarp shipments -o csv > shipments.csvwarp eventsView tracking event historywarp events <SHIPMENT_ID>warp invoiceDisplay invoice detailswarp invoice <ORDER_ID>warp documentsRetrieve order documents (BOL, POD)warp documents <ORDER_ID>warp quote-historyView past quoteswarp quote-history -o json | jq '.[] | .quote_id'warp config setSet CLI configurationwarp config set output jsonwarp whoamiDisplay auth statusOutput formats
All commands support -o / --output:
tableHuman-readable colored table (default)jsonRaw JSON for scripting and pipingcsvComma-separated values for spreadsheetsEnvironments
EnvironmentEndpoint
Production
https://gw.wearewarp.com/api/v1Staging
https://stg.wearewarp.com/api/v1Switch to staging
warp config set endpoint https://stg.wearewarp.com/api/v1Staging and production use separate API keys. Re-authenticate after switching.
Ready to ship?
Get your API key and start moving freight in under 5 minutes.