Sign in

v14

OpenAPI 3.1.02026-08-083813925.4 MB
Shipments

Create Shipment

Attaches a carrier tracking number to a payment and begins tracking it.

post/shipments

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

account_idstring

The unique identifier of the account, prefixed biz_.

payment_idstring required

The payment to attach the shipment to, prefixed pay_.

tracking_numberstring required

The carrier-assigned tracking number.

Response

shipment created

account_idstring required

The account that owns this shipment, prefixed biz_.

carrierstring nullable required

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

created_atstring required

The datetime the shipment was created (ISO 8601).

idstring required

Shipment ID, prefixed ship_.

payment_idstring required

The payment this shipment fulfills, prefixed pay_.

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

The current delivery status of this shipment.

tracking_numberstring required

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

tracking_urlstring required

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

updated_atstring required

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

Example response

{
  "checkpoints": [
    {
      "status": "unknown"
    }
  ],
  "status": "unknown"
}