List shipments

Returns a paginated list of shipments, with optional filtering by payment, company, or user.

Required permissions:

• shipment:basic:read
• payment:basic:read

GET /shipments

JavaScript

JavaScript

import Whop from '@whop/sdk';

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

// Automatically fetches more pages as needed.
for await (const shipment of client.shipments.list()) {
  console.log(shipment.id);
}

200

{
  "data": [
    {
      "created_at": "2023-12-01T05:00:00.401Z",
      "delivery_estimate": "2023-12-01T05:00:00.401Z",
      "id": "ship_xxxxxxxxxxxxx",
      "payment": {
        "id": "pay_xxxxxxxxxxxxxx"
      },
      "service": "Priority",
      "status": "unknown",
      "substatus": "address_correction",
      "tracking_code": "9400111899223456789012",
      "updated_at": "2023-12-01T05:00:00.401Z"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

Authorizations

Authorization · string · header · required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Query Parameters

after · string

Returns the elements in the list that come after the specified cursor.

before · string

Returns the elements in the list that come before the specified cursor.

first · integer

Returns the first n elements from the list.

Example:

42

last · integer

Returns the last n elements from the list.

Example:

42

payment_id · string

Filter shipments to only those associated with this specific payment.

Example:

"pay_xxxxxxxxxxxxxx"

company_id · string

Filter shipments to only those belonging to this company.

Example:

"biz_xxxxxxxxxxxxxx"

user_id · string

Filter shipments to only those for this specific user.

Example:

"user_xxxxxxxxxxxxx"

Response

200

application/json

A successful response

The connection type for Shipment.

data · object[] · required

A list of nodes.

Show child attributes

page_info · object · required

Information to aid in pagination.

Show child attributes