Skip to main content

This complex type contains information about the weight of an object such as a shipping package.

Type that uses Weight

PackageSpecification

Calls that use Weight

POST
/shipment/{shipmentId}/cancel
POST
/shipment/create_from_shipping_quote
GET
/shipment/{shipmentId}
POST
/shipping_quote
GET
/shipping_quote/{shippingQuoteId}

Fields

Field
Type
Description
unit
WeightUnitOfMeasureEnum
The unit of measurement used to specify the weight of a shipping package. Both the unit and value fields are required if the weight container is used. If the English system of measurement is being used, the applicable values for weight units are POUND and OUNCE. If the metric system of measurement is being used, the applicable values for weight units are KILOGRAM and GRAM. The metric system is used by most countries outside of the US.
value
string
The numeric value of the weight of the package, as measured by the value of unit.