Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Rye API key

Query Parameters

limit
integer<int32>

Maximum number of results to return (default 100)

Required range: 1 <= x <= 100
after
string
before
string
ids
string[]
status
enum<string>[]
Available options:
out_for_delivery,
delivered,
shipped,
canceled,
delayed,
ordered

Response

Paginated shipments response

pageInfo
object
required
data
(Shipped · object | Delivered · object | Delayed · object | Out for Delivery · object | Ordered · object | Canceled · object)[]
required

Shipments that have tracking information (shipped, delayed, or delivered states)