Skip to main content
POST
/
book
Book an LTL shipment
curl --request POST \
  --url https://api.shippeek.dev/book \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "rateId": "<string>",
  "schedulePickup": false,
  "shareShipmentEmails": [
    "jsmith@example.com"
  ],
  "bolNum": "<string>",
  "originCompany": "<string>",
  "originAddress": "<string>",
  "originAddress2": "<string>",
  "originContactName": "<string>",
  "originContactPhone": "<string>",
  "originContactEmail": "jsmith@example.com",
  "originReferenceNumber": "<string>",
  "originInstructions": "<string>",
  "originDockHoursOpen": "<string>",
  "originDockHoursClose": "<string>",
  "destCompany": "<string>",
  "destAddress": "<string>",
  "destAddress2": "<string>",
  "destContactName": "<string>",
  "destContactPhone": "<string>",
  "destContactEmail": "jsmith@example.com",
  "destReferenceNumber": "<string>",
  "destInstructions": "<string>",
  "destDockHoursOpen": "<string>",
  "destDockHoursClose": "<string>",
  "emergencyName": "<string>",
  "emergencyPhone": "<string>"
}
'
{
  "id": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "direction": "outbound",
  "dispatch": {
    "carrierId": "<string>",
    "carrier": "<string>",
    "carrierCode": "<string>",
    "schedulePickup": true,
    "bolStatus": "<string>",
    "pickupNum": "<string>",
    "proNum": "<string>",
    "items": [
      {
        "itemId": "<string>",
        "index": 123,
        "trackingNum": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Your ShipPeek API token in the format client_id.client_secret.

Query Parameters

labelSize
enum<string>
default:4x6

Label size for the shipment

Available options:
2.25x4,
3x4,
3x5,
3.5x5,
4x1,
4x2,
4x3.3,
4x6,
4x8,
5.5x8.5,
8.5x11
labelCount
enum<integer>

Number of labels per handling unit

Available options:
1,
2,
4

Body

application/json
id
string
required

Quote ID from the rate response

rateId
string
required

Rate ID of the selected rate

schedulePickup
boolean
default:false

Whether to schedule a carrier pickup

shareShipmentEmails
string<email>[]

Email addresses to share shipment details with

bolNum
string

Custom BOL number. Auto-generated if not provided.

originCompany
string
originAddress
string
originAddress2
string
originContactName
string
originContactPhone
string
originContactEmail
string<email>
originReferenceNumber
string

Reference number (e.g. order number)

originInstructions
string
originDockHoursOpen
string

Dock open time (e.g. 9:00 AM)

originDockHoursClose
string

Dock close time (e.g. 5:00 PM)

destCompany
string
destAddress
string
destAddress2
string
destContactName
string
destContactPhone
string
destContactEmail
string<email>
destReferenceNumber
string

Reference number (e.g. PO number)

destInstructions
string
destDockHoursOpen
string
destDockHoursClose
string
emergencyName
string

Required for hazardous shipments

emergencyPhone
string

Required for hazardous shipments

Response

Shipment booked successfully

id
string

ShipPeek shipment ID

createdDate
string<date-time>
status
string
direction
enum<string>
Available options:
outbound,
inbound,
third-party
dispatch
object