FreightCake
API Reference

Freight

LTL-specific shipment workflows.

List freight shipments

GET/api/v1/freight

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

limit?integer

Page size. Defaults to a server-chosen value; maximum 100.

Range1 <= value <= 100
starting_after?string

Cursor: return records after this id.

ending_before?string

Cursor: return records before this id.

customer_id?integer

Filter by customer.

Range0 <= value
status?string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/freight"
{  "object": "list",  "data": [    {      "object": "shipment",      "id": 0,      "customer_id": 0,      "status": "string",      "carrier_name": "string",      "service_level": "string",      "tracking_number": "string",      "pro_number": "string",      "bol_number": "string",      "origin": {        "city": "string",        "state": "st",        "zip": "string",        "company": "string",        "contact": "string",        "address": "string",        "phone": "string",        "email": "user@example.com"      },      "destination": {        "city": "string",        "state": "st",        "zip": "string",        "company": "string",        "contact": "string",        "address": "string",        "phone": "string",        "email": "user@example.com"      },      "total_charge_cents": 0,      "pickup_date": "string",      "delivery_estimate": "string",      "created_at": "string"    }  ],  "has_more": true,  "url": "/api/v1/freight"}

Create a freight shipment

POST/api/v1/freight

Freight endpoints mirror the shipment endpoints for LTL-specific workflows.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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/freight" \  -H "Content-Type: application/json" \  -d '{    "quote_id": 0  }'
{  "object": "shipment",  "id": 0,  "customer_id": 0,  "status": "string",  "carrier_name": "string",  "service_level": "string",  "tracking_number": "string",  "pro_number": "string",  "bol_number": "string",  "origin": {    "city": "string",    "state": "st",    "zip": "string",    "company": "string",    "contact": "string",    "address": "string",    "phone": "string",    "email": "user@example.com"  },  "destination": {    "city": "string",    "state": "st",    "zip": "string",    "company": "string",    "contact": "string",    "address": "string",    "phone": "string",    "email": "user@example.com"  },  "total_charge_cents": 0,  "pickup_date": "string",  "delivery_estimate": "string",  "created_at": "string"}

Retrieve a freight shipment

GET/api/v1/freight/{id}

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

id*string

Resource identifier.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/freight/string"
{  "object": "shipment",  "id": 0,  "customer_id": 0,  "status": "string",  "carrier_name": "string",  "service_level": "string",  "tracking_number": "string",  "pro_number": "string",  "bol_number": "string",  "origin": {    "city": "string",    "state": "st",    "zip": "string",    "company": "string",    "contact": "string",    "address": "string",    "phone": "string",    "email": "user@example.com"  },  "destination": {    "city": "string",    "state": "st",    "zip": "string",    "company": "string",    "contact": "string",    "address": "string",    "phone": "string",    "email": "user@example.com"  },  "total_charge_cents": 0,  "pickup_date": "string",  "delivery_estimate": "string",  "created_at": "string"}

Update a freight shipment

PATCH/api/v1/freight/{id}

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

id*string

Resource identifier.

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

application/json

curl -X PATCH "https://example.com/api/v1/freight/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "object": "shipment",  "id": 0,  "customer_id": 0,  "status": "string",  "carrier_name": "string",  "service_level": "string",  "tracking_number": "string",  "pro_number": "string",  "bol_number": "string",  "origin": {    "city": "string",    "state": "st",    "zip": "string",    "company": "string",    "contact": "string",    "address": "string",    "phone": "string",    "email": "user@example.com"  },  "destination": {    "city": "string",    "state": "st",    "zip": "string",    "company": "string",    "contact": "string",    "address": "string",    "phone": "string",    "email": "user@example.com"  },  "total_charge_cents": 0,  "pickup_date": "string",  "delivery_estimate": "string",  "created_at": "string"}

Cancel a freight shipment

POST/api/v1/freight/{id}/cancel

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

id*string

Resource identifier.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/freight/string/cancel"
{  "object": "shipment",  "id": 0,  "customer_id": 0,  "status": "string",  "carrier_name": "string",  "service_level": "string",  "tracking_number": "string",  "pro_number": "string",  "bol_number": "string",  "origin": {    "city": "string",    "state": "st",    "zip": "string",    "company": "string",    "contact": "string",    "address": "string",    "phone": "string",    "email": "user@example.com"  },  "destination": {    "city": "string",    "state": "st",    "zip": "string",    "company": "string",    "contact": "string",    "address": "string",    "phone": "string",    "email": "user@example.com"  },  "total_charge_cents": 0,  "pickup_date": "string",  "delivery_estimate": "string",  "created_at": "string"}

Retrieve freight tracking

GET/api/v1/freight/{id}/tracking

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

id*string

Resource identifier.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/freight/string/tracking"
{  "object": "tracking",  "tracking_number": "string",  "carrier_name": "string",  "status": "string",  "estimated_delivery": "string",  "delivered_at": "string",  "events": [    {      "status": "string",      "description": "string",      "location": "string",      "occurred_at": "string"    }  ]}

Retrieve the freight bill of lading

GET/api/v1/freight/{id}/bol

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

id*string

Resource identifier.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/freight/string/bol"
{  "object": "bol",  "bol_number": "string"}

Download the freight bill of lading PDF

GET/api/v1/freight/{id}/bol/pdf

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

id*string

Resource identifier.

Response Body

application/pdf

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/freight/string/bol/pdf"
"string"

Quotes

Rate-shop freight across every enabled carrier.

Tracking

Follow shipments from pickup to delivery.