Rate data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model

shipment_idstring
Reference to the shipping object (if rate is for existing shipment)
currencystring
from_addressobject
Origin address
to_addressobject
Destination address
packages array
Multiple packages (alternative to package)
ship_by_atdate
Latest date to ship (from order) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
carrier_idstring
Reference to the carrier
idstring
Unique identifier for this rate object
rates array
Are we missing anything? Let us know
Was this page helpful?