Quotes
Rate-shop freight across every enabled carrier.
/api/v1/quotesAuthorization
ApiKeyAuth Authenticate with your secret API key in the Authorization header: Authorization: Bearer fk_live_.... Use an fk_test_ key to operate against test mode, which never contacts a carrier or moves real freight.
In: header
Query Parameters
Page size. Defaults to a server-chosen value; maximum 100.
1 <= value <= 100Cursor: return records after this id.
Cursor: return records before this id.
Filter by customer.
0 <= valueResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/quotes"{ "object": "list", "data": [ { "object": "quote", "id": 0, "customer_id": 0, "quote_group_id": "string", "quote_number": "string", "carrier_name": "string", "service_level": "string", "status": "string", "net_charge_cents": 0, "transit_days": 0, "delivery_estimate": "string", "origin_terminal": "string", "destination_terminal": "string", "origin": { "city": "string", "state": "string", "zip": "string" }, "destination": { "city": "string", "state": "string", "zip": "string" }, "dimensions": { "length": 0, "width": 0, "height": 0, "weight": 0 }, "freight_class": "string", "nmfc_code": "string", "nmfc_item_number": "string", "nmfc_sub_code": "string", "expires_at": "string", "created_at": "string" } ], "has_more": true, "url": "/api/v1/quotes"}/api/v1/quotesRate-shops the shipment across every enabled carrier and returns one quote per carrier/service combination. Supports the Idempotency-Key header.
Authorization
ApiKeyAuth Authenticate with your secret API key in the Authorization header: Authorization: Bearer fk_live_.... Use an fk_test_ key to operate against test mode, which never contacts a carrier or moves real freight.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/quotes" \ -H "Content-Type: application/json" \ -d '{ "origin": { "city": "string", "state": "st", "zip": "string" }, "destination": { "city": "string", "state": "st", "zip": "string" }, "items": [ { "weight": 0, "freight_class": "string", "length": 0, "width": 0, "height": 0 } ] }'{ "object": "list", "data": [ { "object": "quote", "id": 0, "customer_id": 0, "quote_group_id": "string", "quote_number": "string", "carrier_name": "string", "service_level": "string", "status": "string", "net_charge_cents": 0, "transit_days": 0, "delivery_estimate": "string", "origin_terminal": "string", "destination_terminal": "string", "origin": { "city": "string", "state": "string", "zip": "string" }, "destination": { "city": "string", "state": "string", "zip": "string" }, "dimensions": { "length": 0, "width": 0, "height": 0, "weight": 0 }, "freight_class": "string", "nmfc_code": "string", "nmfc_item_number": "string", "nmfc_sub_code": "string", "expires_at": "string", "created_at": "string" } ], "has_more": true, "url": "/api/v1/quotes"}/api/v1/quotes/{id}Authorization
ApiKeyAuth Authenticate with your secret API key in the Authorization header: Authorization: Bearer fk_live_.... Use an fk_test_ key to operate against test mode, which never contacts a carrier or moves real freight.
In: header
Path Parameters
Resource identifier.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/quotes/string"{ "object": "quote", "id": 0, "customer_id": 0, "quote_group_id": "string", "quote_number": "string", "carrier_name": "string", "service_level": "string", "status": "string", "net_charge_cents": 0, "transit_days": 0, "delivery_estimate": "string", "origin_terminal": "string", "destination_terminal": "string", "origin": { "city": "string", "state": "string", "zip": "string" }, "destination": { "city": "string", "state": "string", "zip": "string" }, "dimensions": { "length": 0, "width": 0, "height": 0, "weight": 0 }, "freight_class": "string", "nmfc_code": "string", "nmfc_item_number": "string", "nmfc_sub_code": "string", "expires_at": "string", "created_at": "string"}/api/v1/quotes/group/{groupId}Returns every carrier quote produced by a single rate-shop request.
Authorization
ApiKeyAuth Authenticate with your secret API key in the Authorization header: Authorization: Bearer fk_live_.... Use an fk_test_ key to operate against test mode, which never contacts a carrier or moves real freight.
In: header
Path Parameters
Quote group identifier.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/quotes/group/string"{ "object": "list", "data": [ { "object": "quote", "id": 0, "customer_id": 0, "quote_group_id": "string", "quote_number": "string", "carrier_name": "string", "service_level": "string", "status": "string", "net_charge_cents": 0, "transit_days": 0, "delivery_estimate": "string", "origin_terminal": "string", "destination_terminal": "string", "origin": { "city": "string", "state": "string", "zip": "string" }, "destination": { "city": "string", "state": "string", "zip": "string" }, "dimensions": { "length": 0, "width": 0, "height": 0, "weight": 0 }, "freight_class": "string", "nmfc_code": "string", "nmfc_item_number": "string", "nmfc_sub_code": "string", "expires_at": "string", "created_at": "string" } ], "has_more": true, "url": "/api/v1/quotes"}