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",
  "checkoutIntentId": "<string>",
  "id": "<string>",
  "trackingEvents": [
    {
      "location": {
        "country": "<string>",
        "province": "<string>",
        "city": "<string>"
      },
      "displayTime": "<string>",
      "displayDate": "<string>",
      "description": "<string>"
    }
  ],
  "shippedAt": "2023-11-07T05:31:56Z",
  "tracking": {
    "number": "<string>",
    "carrierName": "<string>",
    "estimatedDeliveryDate": "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

updatedAt
string<date-time>
required
createdAt
string<date-time>
required
checkoutIntentId
string
required
id
string
required
trackingEvents
object[]
required
shippedAt
string<date-time>
required
tracking
object
required
externalId
string
required
status
enum<string>
required
Available options:
shipped