Shipments

List Shipments

Changed on

Lists an account's shipments.

get/shipments

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/shipments
  • Auth: HTTP bearer

Query parameters

account_idstring

The account to list shipments for. Defaults to the acting account.

status'unknown' | 'pre_transit' | 'in_transit' | 'out_for_delivery' | 'delivered' | 'available_for_pickup' | 'return_to_sender' | 'failure' | 'cancelled' | 'error'

Filter to shipments with this delivery status.

payment_idstring[]

Only shipments fulfilling these payments, each prefixed pay_. Repeat the parameter to pass several, up to 100 per request — one paginated list covers all of them.

[
  "pay_xxxxxxxxxxxxxx"
]
created_beforestring

Return shipments created before this ISO 8601 timestamp.

created_afterstring

Return shipments created after this ISO 8601 timestamp.

order'created_at'

The field to sort by.

direction'asc' | 'desc'

The sort direction.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

excludes the created_after boundary row

Example response

{
  "data": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "carrier": "ups",
      "checkpoints": [
        {
          "location": "PHILADELPHIA, PA",
          "message": "Picked up",
          "status": "in_transit",
          "timestamp": "2026-01-01T12:00:00.000Z"
        }
      ],
      "created_at": "2026-01-01T12:00:00.000Z",
      "id": "ship_xxxxxxxxxxxxxx",
      "payment_id": "pay_xxxxxxxxxxxxxx",
      "status": "in_transit",
      "tracking_number": "1Z999AA10123456784",
      "tracking_url": "https://track.aftership.com/xxxxxxxxxxxxxxxxxx",
      "updated_at": "2026-01-01T12:00:00.000Z"
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

  • ff3a76573563Revision changes
    • breaking

      for the query request parameter first, default value 20 was added

    • warning

      for the query request parameter first, the max was set to 100.00

    • warning

      for the query request parameter last, the max was set to 100.00

  • db0883548bc5Revision changes
    • info

      added the required property // to the response with the status