Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Rye API key

Scopes

checkout_intents:read

Path Parameters

id
string
required

The id of the shipment to look up

Response

Shipment information

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

updatedAt
string<date-time>
required
createdAt
string<date-time>
required
marketplaceOrderId
string
required
checkoutIntentId
string
required
id
string
required
trackingEvents
object[]
required
shippedAt
string<date-time>
required
tracking
object
required
externalId
string
required

The external ID is provided by the marketplace and matches the shipment to their system.

status
enum<string>
required
Available options:
shipped