A Rate model represents the estimated cost to ship a shipment from an origin address to a destination address.


Properties are protected and can be accessed with their getPropertyName() getter method or set via setPropertyName(value) setter method.

carrierCarrierInterfaceThe carrier associated with the rate.
serviceName?stringThe name of the carrier service this rate is for.
serviceCode?stringThe code or identifier of the carrier service this rate is for.
rate?stringThe amount for the rate.
currency?stringThe currency code for the rate.
deliveryDays?intThe number of delivery days estimated (carrier support).
deliveryDate?DateTimeThe date for estimated delivery (carrier support).
deliveryDateGuaranteed?boolWhether the delivery date is guaranteed (carrier support).
responsearrayThe raw response from the carrier API for the rate response.