merchantId
required |
string (uuid)
|
The merchant the quote is for. The caller must be authorized over this merchant; an API key
quotes only for the merchant it belongs to.
nullable
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.
|
originId
required |
string (uuid)
|
The id of a saved ship-from origin belonging to the merchant. Give this or `origin`,
not both.
Conditional: When OriginId is not null.
nullable
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.
|
origin
required |
Address
Address |
A ship-from address supplied inline, for a quote from a location the merchant has not saved.
Give this or `originId`, not both.
Conditional: When Origin is not null.
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 of Address:
| Field |
Type |
Description |
|---|
id
required |
string (uuid)
|
Gets the unique identifier for the address.
read only
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.
| address1
required |
string
|
Gets or sets the first line of the address (e.g., street address).
nullablemax length 100
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.
| address2
required |
string
|
Gets or sets the second line of the address (e.g., apartment, suite, unit, building, floor, etc.).
nullablemax length 100
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.
| city
required |
string
|
Gets or sets the city of the address.
nullablemax length 100
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.
| state
required |
string
|
Gets or sets the state or region of the address.
nullablemax length 100
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.
| province
required |
string
|
Gets or sets the province of the address (if applicable).
nullable
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.
| zip
required |
string
|
Gets or sets the ZIP code of the address.
Conditional: Conditional (see validator source). Pattern: ^\d{5}(-\d{4})?$.
Conditional: When IsUsCountry(Country) is false. Max length: 20.
nullable
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.
| postalCode
required |
string
|
Gets or sets the postal code of the address.
nullablemax length 20
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.
| country
required |
string
|
Gets or sets the country of the address. Defaults to "USA".
nullablemax length 100
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.
| isMailing
required |
boolean
|
Gets or sets a value indicating whether this address is a mailing address.
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.
| isDefault
required |
boolean
|
Gets or sets a value indicating whether this address is the default address.
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.
|
This body has no documented fields. |
destination
required |
Address
Address |
The address the parcels ship to.
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 of Address:
| Field |
Type |
Description |
|---|
id
required |
string (uuid)
|
Gets the unique identifier for the address.
read only
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.
| address1
required |
string
|
Gets or sets the first line of the address (e.g., street address).
nullablemax length 100
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.
| address2
required |
string
|
Gets or sets the second line of the address (e.g., apartment, suite, unit, building, floor, etc.).
nullablemax length 100
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.
| city
required |
string
|
Gets or sets the city of the address.
nullablemax length 100
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.
| state
required |
string
|
Gets or sets the state or region of the address.
nullablemax length 100
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.
| province
required |
string
|
Gets or sets the province of the address (if applicable).
nullable
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.
| zip
required |
string
|
Gets or sets the ZIP code of the address.
Conditional: Conditional (see validator source). Pattern: ^\d{5}(-\d{4})?$.
Conditional: When IsUsCountry(Country) is false. Max length: 20.
nullable
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.
| postalCode
required |
string
|
Gets or sets the postal code of the address.
nullablemax length 20
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.
| country
required |
string
|
Gets or sets the country of the address. Defaults to "USA".
nullablemax length 100
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.
| isMailing
required |
boolean
|
Gets or sets a value indicating whether this address is a mailing address.
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.
| isDefault
required |
boolean
|
Gets or sets a value indicating whether this address is the default address.
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.
|
This body has no documented fields. |
destinationIsResidential
required |
boolean
|
Whether the destination is a residence. Some carriers price residential delivery differently;
leave unset when unknown and the provider applies its own default.
nullable
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.
|
parcelPresetIds
required |
array of string (uuid)
array of |
The ids of saved parcel presets belonging to the merchant, one per parcel in the shipment. Give
this or `parcels`, not both.
nullable
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.
|
parcels
required |
array of ShippingRateQuoteParcelDto
array of ShippingRateQuoteParcelDto |
The parcels supplied inline, one per parcel in the shipment. Give this or
`parcelPresetIds`, not both.
nullable
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 of each ShippingRateQuoteParcelDto:
| 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 body has no documented fields. |
carriers
required |
array of string
array of |
Optional provider-specific carrier account identifiers to restrict the quote to. When omitted the
provider quotes every carrier the binding allows.
nullable
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.
|
serviceLevels
required |
array of string
array of |
Optional provider-specific service level tokens to restrict the quote to. When omitted the provider
returns every service level the binding allows.
nullable
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.
|
currency
required |
string
|
The ISO 4217 currency the quotes should be expressed in. When omitted the platform's configured
default currency is requested.
Conditional: When Currency is not empty.
nullable
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.
|