View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.

API reference Models

ShippingRateQuoteParcelDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

One parcel supplied inline on a rate quote request, for an order whose parcel is known at the time of the quote rather than drawn from a saved preset.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description
weight required number (double) The packed weight of the parcel, in `weightUnit`. greater than 0max 100000
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
weightUnit required ShippingWeightUnit ShippingWeightUnit The unit `weight` is given in. Defaults to pounds.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Gram Grams.
Kilogram Kilograms.
Ounce Ounces (avoirdupois).
Pound Pounds (avoirdupois).
length required number (double) The longest outer side of the parcel, in `dimensionUnit`. greater than 0max 10000
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
width required number (double) The second outer side of the parcel, in `dimensionUnit`. greater than 0max 10000
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
height required number (double) The third outer side of the parcel, in `dimensionUnit`. greater than 0max 10000
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
dimensionUnit required ShippingDimensionUnit ShippingDimensionUnit The unit the three sides are given in. Defaults to inches.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Centimeter Centimetres.
Inch Inches.

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.