Skip to main content
GET
List deliveries

Authorizations

Authorization
string
header
required

A business-bound HaulStow API key. Send Authorization: Bearer hsg_live_key_... to the live server or a hsg_test_key_... key to the sandbox server. Never expose this key in a browser.

Headers

X-Request-ID
string

Optional caller correlation ID. Use 1–128 ASCII letters, digits, ., _, -, or :. Invalid values are replaced. The accepted/generated value is returned in the response.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._:-]+$

Query Parameters

cursor
string

Opaque cursor returned as meta.next_cursor. Do not construct or modify it.

Maximum string length: 512
limit
integer
default:25

Number of resources to return.

Required range: 1 <= x <= 100
status
enum<string>

Filter by one public delivery status.

Available options:
booked,
assigned,
picked_up,
in_transit,
delivered,
failed,
cancelled,
outsourced
Example:

"in_transit"

external_id
string

Match one application-defined external ID.

Maximum string length: 128
created_after
string<date-time>

Include deliveries created at or after this RFC 3339 timestamp.

created_before
string<date-time>

Include deliveries created before this RFC 3339 timestamp.

Response

Delivery page returned.

success
boolean
required
statusCode
enum<integer>
required
Available options:
200
message
string
required
data
object[]
required
meta
object
required