Skip to main content
GET
/
api
/
v1
/
shipments
/
{id}
JavaScript
import CheckoutIntents from 'checkout-intents';

const client = new CheckoutIntents({
  apiKey: process.env['CHECKOUT_INTENTS_API_KEY'], // This is the default and can be omitted
});

const shipment = await client.shipments.retrieve('id');

console.log(shipment);
{
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "marketplaceOrderId": "<string>",
  "checkoutIntentId": "<string>",
  "id": "<string>",
  "trackingEvents": [
    {
      "status": "out_for_delivery",
      "location": {
        "country": "<string>",
        "province": "<string>",
        "city": "<string>"
      },
      "timestamp": {
        "local": "<string>",
        "utc": "2023-11-07T05:31:56Z"
      },
      "description": "<string>"
    }
  ],
  "shippedAt": "2023-11-07T05:31:56Z",
  "tracking": {
    "number": "<string>",
    "carrierName": "<string>",
    "deliveryDate": {
      "estimated": "2023-11-07T05:31:56Z"
    },
    "url": "<string>"
  },
  "externalId": "<string>",
  "status": "shipped"
}

Authorizations

Authorization
string
header
required

Rye API key

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