Sign in

v1

latestOpenAPI 3.1.02026-07-26162740.3 KB
Shipments

Create a shipment

Creates a new shipment in DRAFT status. The shipment must be purchased separately before a label can be generated.

post/client/shipments/create

Request body

packagingIdinteger

ID of a pre-configured packaging profile. Use instead of dimensions if the package matches a saved profile.

postageType'PUBLICATION' | 'SAME DAY' | 'NEXT DAY' | 'STANDARD' | 'USPS Ground Advantage' | 'PostNL International Packet Tracked' | 'OTHER' required

Preferred postage type. Domestic shipments typically use SAME DAY, NEXT DAY, or STANDARD. Cross-border CA→US shipments use USPS Ground Advantage (DDP) or PostNL International Packet Tracked (DDU). If the requested type is unavailable, an available type is selected automatically.

notestring

Optional note, up to 200 characters.

insuranceRequiredboolean

Whether parcel protection (insurance) is required for this shipment.

orderNumberstring

Optional client-provided order reference.

Response

Shipment created or error returned

messagestring required

Additional information about the request status.

codeinteger required

Status code. 0 indicates success.