Skip to main content
POST
/
rates
/
parcel
Get parcel rates
curl --request POST \
  --url https://api.shippeek.dev/rates/parcel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "originPostalCode": "<string>",
  "destPostalCode": "<string>",
  "items": [
    {
      "weight": 123,
      "length": 123,
      "width": 123,
      "height": 123,
      "quantity": 1,
      "package": "Custom"
    }
  ],
  "pickupDate": "2023-12-25",
  "charges": [
    "signature required"
  ],
  "originCountry": "USA",
  "originType": "business dock",
  "destCountry": "USA",
  "destType": "business dock",
  "schedulePickup": false
}
'
{
  "id": "<string>",
  "rates": [
    {
      "id": "<string>",
      "status": "ok",
      "mode": "LTL",
      "paymentTerms": "<string>",
      "total": 123,
      "ref": "<string>",
      "days": 123,
      "serviceType": "<string>",
      "serviceDescription": "<string>",
      "time": 123,
      "carrierId": "<string>",
      "carrier": "<string>",
      "carrierCode": "<string>",
      "charges": [
        {
          "name": "<string>",
          "amount": 123
        }
      ],
      "bookUrl": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.shippeek.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Your ShipPeek API token in the format client_id.client_secret.

Body

application/json
​
originPostalCode
string
required
​
destPostalCode
string
required
​
items
object[]
required
​
pickupDate
string<date>
​
charges
enum<string>[]

Parcel-specific accessorial charges

Available options:
signature required,
adult signature required,
indirect signature required
​
originCountry
enum<string>
default:USA
Available options:
USA,
CAN
​
originType
enum<string>
default:business dock
Available options:
business dock,
business no dock,
residential
​
destCountry
enum<string>
default:USA
Available options:
USA,
CAN
​
destType
enum<string>
default:business dock
Available options:
business dock,
business no dock,
residential
​
schedulePickup
boolean
default:false

Whether to include pickup scheduling with the booking

Response

Parcel rates returned successfully

​
id
string
​
rates
object[]