Skip to main content
GET
/
shipments
JavaScript
import Whopsdk from 'whopsdk';

const client = new Whopsdk({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const shipmentListResponse of client.shipments.list({ company_id: 'biz_xxxxxxxxxxxxxx' })) {
  console.log(shipmentListResponse.id);
}
{
  "data": [
    {
      "id": "ship_xxxxxxxxxxxxx",
      "created_at": 1701406800,
      "status": "unknown",
      "substatus": "address_correction",
      "tracking_code": "<string>",
      "updated_at": 1701406800,
      "carrier": "accurate",
      "service": "<string>",
      "delivery_estimate": 1701406800,
      "payment": {
        "id": "pay_xxxxxxxxxxxxxx"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

Query Parameters

after
string | null

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

before
string | null

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

first
integer | null

Returns the first n elements from the list.

Example:

42

last
integer | null

Returns the last n elements from the list.

Example:

42

payment_id
string | null

The ID of the payment

Example:

"pay_xxxxxxxxxxxxxx"

company_id
string
required

The ID of the company

Example:

"biz_xxxxxxxxxxxxxx"

user_id
string | null

The ID of the user

Example:

"user_xxxxxxxxxxxxx"

Response

A successful response

The connection type for Shipment.

data
array | null
required

A list of nodes.

page_info
object
required

Information to aid in pagination.

I