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 shipmentListResponse of client.shipments.list()) {
console.log(shipmentListResponse.id);
}{
"data": [
{
"id": "ship_xxxxxxxxxxxxx",
"created_at": "2023-12-01T05:00:00.401Z",
"status": "unknown",
"substatus": "address_correction",
"tracking_code": "9400111899223456789012",
"updated_at": "2023-12-01T05:00:00.401Z",
"carrier": "accurate",
"service": "Priority",
"delivery_estimate": "2023-12-01T05:00:00.401Z",
"payment": {
"id": "pay_xxxxxxxxxxxxxx"
}
}
],
"page_info": {
"end_cursor": "<string>",
"start_cursor": "<string>",
"has_next_page": true,
"has_previous_page": true
}
}Returns a paginated list of shipments, with optional filtering by payment, company, or user.
Required permissions:
shipment:basic:readpayment:basic:readimport 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 shipmentListResponse of client.shipments.list()) {
console.log(shipmentListResponse.id);
}{
"data": [
{
"id": "ship_xxxxxxxxxxxxx",
"created_at": "2023-12-01T05:00:00.401Z",
"status": "unknown",
"substatus": "address_correction",
"tracking_code": "9400111899223456789012",
"updated_at": "2023-12-01T05:00:00.401Z",
"carrier": "accurate",
"service": "Priority",
"delivery_estimate": "2023-12-01T05:00:00.401Z",
"payment": {
"id": "pay_xxxxxxxxxxxxxx"
}
}
],
"page_info": {
"end_cursor": "<string>",
"start_cursor": "<string>",
"has_next_page": true,
"has_previous_page": true
}
}A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
42
Returns the last n elements from the list.
42
Filter shipments to only those associated with this specific payment.
"pay_xxxxxxxxxxxxxx"
Filter shipments to only those belonging to this company.
"biz_xxxxxxxxxxxxxx"
Filter shipments to only those for this specific user.
"user_xxxxxxxxxxxxx"
Was this page helpful?