WHwhatnot
Shipments

Get a shipment

Retrieve a shipment owned by the authenticated seller. Requires read:shipments.

get/shipments/{shipment_id}

Request

  • Base URL
    https://api.whatnot.com/seller-api/rest/v2
  • URL
    https://api.whatnot.com/seller-api/rest/v2/shipments/{shipment_id}
  • Auth
    OAuth 2
    Authorization code: https://api.whatnot.com/seller-api/rest/oauth/authorize
    Token URL: https://api.whatnot.com/seller-api/rest/oauth/token

Path parameters

shipment_idstring required

The shipment's ID.

Response

Successful Response

idstring required

The shipment's ID.

urlstring required

The url of the shipment in the seller's dashboard.

status'created' | 'label_generated' | 'dropped_off' | 'in_transit' | 'delivered' | 'failed' | 'cancelled' | 'cancelled_not_shipped' | 'cancelled_not_shipped_with_dropoff' | 'cancelled_tracking_stuck' required
fulfillment_method'shipping' | 'pickup' required
signature_requiredboolean required

Whether delivery requires a signature.

hazardous_material'not_hazardous' | 'standard' | 'lithium_battery' required
required_actionsShipmentRequiredAction[] required

Actions required before fulfillment.

dropoff_duestring date-time nullable required

Due date at seller-local midnight, serialized with timezone; not the overdue cutoff. Null for pickup, non-pre-transit shipments, or missing inputs.

replacement_shipment_idstring nullable required

Immediate successor shipment ID after replacement, bundling, or splitting; not the final successor in a chain.

created_atstring date-time nullable required

Creation timestamp, if recorded.

updated_atstring date-time nullable required

Last update timestamp, if recorded.

Example response

{
  "created_at": "2026-09-21T12:00:00.000Z",
  "dimensions": {
    "height": 1,
    "length": 6,
    "unit": "inch",
    "width": 4
  },
  "dropoff_due": "2026-09-23T07:00:00.000Z",
  "fulfillment_method": "shipping",
  "hazardous_material": "not_hazardous",
  "id": "12345",
  "insurance": {
    "amount": {
      "amount": "25.00",
      "currency": "USD"
    },
    "contents": "Trading cards"
  },
  "recipient": {
    "display_name": "Card Collector",
    "id": "6789",
    "username": "cardcollector"
  },
  "required_actions": [],
  "signature_required": false,
  "status": "label_generated",
  "tracking": {
    "carrier": "usps",
    "service": "usps_ground_advantage",
    "tracking_code": "9400111899223100012345"
  },
  "updated_at": "2026-09-21T13:00:00.000Z",
  "url": "https://www.whatnot.com/dashboard/shipments/U2hpcG1lbnROb2RlOjUxMjU0MTM5Mw==",
  "weight": {
    "unit": "ounce",
    "value": 4
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.