Shipment - Whop Docs

A Shipment attaches a carrier tracking number to a payment and follows the package from label creation to delivery, exposing the current delivery status and a customer-facing tracking URL. Use the Shipments API to list an account’s shipments, retrieve one by its id or the payment it fulfills, attach a tracking number to a payment, and update the tracking number on an existing shipment.

Endpoints

Endpoint	Request
List Shipments	GET `/shipments`
Retrieve Shipment	GET `/shipments/{id}`
Create Shipment	POST `/shipments`
Update Shipment	PATCH `/shipments/{id}`

Attributes

string

required

Shipment ID, prefixed ship_.

string

required

The account that owns this shipment, prefixed biz_.

string | null

required

The shipping carrier detected for this shipment. Null until a tracking update identifies it.

object[]

required

Carrier scan history for this shipment, oldest scan first. Empty until the carrier reports its first scan.

Properties

string | null

required

Where the carrier recorded the scan, such as PHILADELPHIA, PA. Null when the carrier sent none.

string | null

required

Carrier’s description of the scan, such as Departed USPS Regional Facility. Null when the carrier sent none.

string

required

Delivery status this carrier scan maps to.Available options: unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error

string | null

required

When the carrier recorded the scan, as an ISO 8601 timestamp. Null when the carrier sent no scan time.

string

required

The datetime the shipment was created (ISO 8601).

string

required

The payment this shipment fulfills, prefixed pay_.

string

required

The current delivery status of this shipment.Available options: unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error

string

required

The carrier-assigned tracking number used to look up shipment progress.

string

required

A customer-facing URL to track this shipment’s progress.

string

required

The datetime the shipment was last updated (ISO 8601).

Shipment

{
	"id": "ship_xxxxxxxxxxxxxx",
	"account_id": "biz_xxxxxxxxxxxxxx",
	"payment_id": "pay_xxxxxxxxxxxxxx",
	"carrier": "ups",
	"tracking_number": "1Z999AA10123456784",
	"tracking_url": "https://track.aftership.com/xxxxxxxxxxxxxxxxxx",
	"status": "in_transit",
	"checkpoints": [
		{
			"status": "in_transit",
			"message": "Picked up",
			"location": "PHILADELPHIA, PA",
			"timestamp": "2026-09-15T16:42:00.000Z"
		}
	],
	"created_at": "2026-09-15T14:30:00.000Z",
	"updated_at": "2026-09-15T16:45:10.000Z"
}

​Endpoints

​Attributes

Endpoints

Attributes