rate_idstring required
A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.
rate_type'check' | 'shipment' required
The possible rate type values
carrier_idstring required
A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.
zoneinteger nullable required
Certain carriers base their rates off of
custom zones that vary depending upon the ship_to and ship_from location
package_typestring nullable required
package type that this rate was estimated for
delivery_daysinteger nullable
The number of days estimated for delivery, this will show the actual delivery
time if for example, the package gets shipped on a Friday
guaranteed_serviceboolean required
Indicates if the rate is guaranteed.
estimated_delivery_datestring date-time
An ISO 8601 string that represents a date, but not a specific time. The value may contain a time component, but it will be set to 00:00:00 UTC by ShipEngine.
carrier_delivery_daysstring
The carrier delivery days
ship_datestring date-time
negotiated_rateboolean required
Indicates if the rates been negotiated
service_typestring required
service_codestring required
service code for the rate
trackableboolean required
Indicates if rate is trackable
carrier_codestring required
carrier_nicknamestring required
carrier_friendly_namestring required
validation_status'valid' | 'invalid' | 'has_warnings' | 'unknown' required
The possible validation status values
warning_messagesstring[] required
error_messagesstring[] required