How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WARP API Documentation Freight API

[Get The Postman Collection](https://api.postman.com/collections/43153707-51d60bdf-d837-474b-a3d4-4e6522ad81a8?access_key=PMAT-01JPH7GR5Y1Q3JAT2J8DHJEK4T)

WARP API Documentation Freight API is one of 2 APIs that WARP publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 13 operations across 13 paths, organized into 2 resource areas, and defines 39 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://stg.wearewarp.com/api/v1, https://gw.wearewarp.com/api/v1.

13 operations 13 paths 39 schemas 5 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://stg.wearewarp.com/api/v1
Authentication
API Key
Resource Areas
2

Authentication & Security 1

WARP API Documentation Freight API declares 1 security scheme for authenticating requests. An API key is passed in the header as apikey (api_key).

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 5 GET, 8 POST. They span 2 resource areas: Freight, Multi-Stops. Each is listed below with its method, path, parameters, and response codes.

Freight 11

Everything about your Freight

POST
/freights/quote
Get quote for your shipment
quote body → 200400401403429500
POST
/freights/booking
book a shipment
booking body → 200400401403429500
POST
/freights/tracking
tracking shipments
tracking body → 200400401403429500
GET
/freights/shipments
get shipments
get-shipments 9 params → 200400401403429500
GET
/freights/events/{shipmentId}
get events
get-events 1 param → 200400401403429500
GET
/freights/invoices/{orderId}
get invoice
get-invoice 1 param → 200400401403429500
GET
/freights/documents/{orderId}
get documents
get-document 3 params → 200400401403429500
POST
/freights/freight-quote
[Experimental] Get all quote options for your shipment
freight-quote 1 param body → 200400401403429500
POST
/freights/book
[Experimental] Book a shipment using a previous quote ID
book body → 200400401403429500
GET
/freights/quote-history
get quote histories
get-quote-history 5 params → 200400401403429500
POST
/freights/cancel
Cancel an order
cancel-order body → 200400401403409429500
Multi-Stops 2

FTL Multi-Stops quote and booking with intermediate transit points

POST
/freights/quote/multi-stops
Get quote for a multi-stops FTL shipment
multi-stops-quote body → 200400401403429500
POST
/freights/booking/multi-stops
Book a multi-stops FTL shipment
multi-stops-booking body → 200400401403429500

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are ShipmentItem (16 properties), BookShipmentItem (14 properties), QuoteOption (13 properties), MultiStopsStopInfo (12 properties). Each schema is shown below with its type and property counts.

QuoteBody
object
10 properties 4 required
VehicleType
object
1 property
TrackingShipmentQuery
object
1 property 1 required
GetShipmentsSuccess
object
4 properties
BookShipmentItem
object
14 properties 7 required
PickupService
object
2 properties 2 required
DeliveryService
object
2 properties 2 required
AdditionalService
object
2 properties 2 required
BookingSuccess
object
9 properties
BookingShipment
object
12 properties 3 required
Address
object
5 properties 4 required
QuoteResult
object
11 properties
StopInfo
object
11 properties 2 required
TrackingShipmentSuccess
array
TrackInfo
object
7 properties
Shipment
object
10 properties
DeliveryInfo
object
9 properties
ShipmentItem
object
16 properties
FreightQuoteBody
object
8 properties 4 required
FreightBookingShipment
object
6 properties 4 required
BookingStopInfo
object
12 properties 3 required
TimeWindow
object
2 properties 2 required
QuoteOption
object
13 properties
FreightQuoteResult
object
4 properties
BookingResult
object
7 properties
GetEventsSuccess
object
1 property
GetInvoiceSuccess
object
8 properties
CancelOrderBody
object
2 properties 2 required
CancelOrderResult
object
3 properties
GetDocumentsSuccess
object
3 properties
QuoteHistory
object
10 properties
GetQuoteHistorySuccess
array
MultiStopsQuoteBody
object
10 properties 5 required
MultiStopsQuoteResult
object
5 properties
MultiStopsStopInfo
object
12 properties 3 required
MultiStopsShipmentInput
object
6 properties 3 required
MultiStopsBookingBody
object
4 properties 2 required
MultiStopsBookingResult
object
5 properties
ErrorResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wearewarp-com-freight-openapi.json Raw ↑

Other APIs WARP publishes across the network.

Warp Freight API
Where this information came from

This is an independent, third-party profile of WARP API Documentation Freight API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.