Rate

Shipping rate offered by the carrier for the shipment

from_address
Type:
required

The origin address

Properties: 11
to_address
Type:
required

The destination address

Properties: 11
parcel
Type: nullable

The dimensions and weight of the package. Business rule: parcel and parcels MUST NOT both be present.

Properties: 7
parcels
Type:

Array of parcels. Business rule: parcel and parcels MUST NOT both be present.

Properties: 7
options
Type: nullable
Additional shipment options.

Notes (enforced by server/business logic, not schema):
- If carrier_accounts and service are both present and options.create_and_buy is not explicitly false, the server treats create_and_buy as true.
- create_and_buy and create_and_buy_cheapest are mutually exclusive.
Properties: 35
is_return
Type: boolean | null

Set true to create as a return.
carrier
Type: string | null

Carrier to use for the shipment. If both carrier and carrier_accounts are omitted, all carriers are considered.
carrier_accounts
Type: array of string | null

List of specific carrier account IDs to use when rating or buying a shipment. If both carrier and carrier_accounts are omitted, all carriers are considered.