v1

latestOpenAPI 3.1.02026-07-26162740.3 KB

Shipments

Get a pricing quote

Returns estimated shipping rates for a given destination address, package dimensions, weight, and postage type. Does not create a shipment, reserve a rate, charge the merchant, or guarantee final service availability.

post/client/shipments/quote

Request body

packagingIdnumber

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

postageType'STANDARD' | 'USPS Ground Advantage' | 'PostNL International Packet Tracked' required

Requested postage service. STANDARD is for domestic. USPS Ground Advantage is for CA to US cross-border (DDP, merchant pays duties). PostNL International Packet Tracked is for CA to US cross-border (DDU, recipient pays duties). If the requested type is unavailable, an available type is selected automatically.

Response

Estimated rates retrieved successfully

messagestring required

codeinteger required

Status code. 0 indicates success.