Stream LTL rates (SSE)

Stream LTL rates via Server-Sent Events. Rates arrive as they are returned from each carrier, rather than waiting for all carriers to respond. The request body is the same as POST /rates.

POST /rates/ltl/stream

Stream LTL rates (SSE)

cURL

curl --request POST \
  --url https://api.shippeek.dev/rates/ltl/stream \
  --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,
      "description": "<string>",
      "package": "<string>",
      "hazardous": false,
      "nmfc": "<string>"
    }
  ]
}
'

200

"<string>"

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

Show child attributes

Response

200 - text/event-stream

SSE stream of rate events

Each event is a JSON-encoded rate object