SHshipengine
rates

Estimate Rates

Changed on

Get Rate Estimates

post/v1/rates/estimate

Request

  • Base URL
    https://api.shipengine.com
  • URL
    https://api.shipengine.com/v1/rates/estimate
  • Auth
    API key in header API-Key

Request body

from_country_codestring

A two-letter ISO 3166-1 country code

from_postal_codestring

postal code

from_city_localitystring

from postal code

from_state_provincestring

From state province

to_country_codestring

A two-letter ISO 3166-1 country code

to_postal_codestring

postal code

to_city_localitystring

The city locality the package is being shipped to

to_state_provincestring

To state province

confirmation'none' | 'delivery' | 'signature' | 'adult_signature' | 'direct_signature' | 'delivery_mailed' | 'verbal_confirmation' | 'delivery_code' | 'age_verification_16_plus'

The possible delivery confirmation values

address_residential_indicator'unknown' | 'yes' | 'no'

Indicates whether an address is residential.

ship_datestring date-time

An ISO 8601 string that represents a date and time.

Example request

{
  "from_country_code": "CA",
  "from_postal_code": "78756-3717",
  "from_city_locality": "Austin",
  "from_state_province": "Austin",
  "to_country_code": "CA",
  "to_postal_code": "78756-3717",
  "to_city_locality": "Austin",
  "to_state_province": "Houston",
  "ship_date": "2018-09-23T15:00:00.000Z"
}

Response

The request was a success.

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

ship date

negotiated_rateboolean required

Indicates if the rates been negotiated

service_typestring required

service type

service_codestring required

service code for the rate

trackableboolean required

Indicates if rate is trackable

carrier_codestring required

A shipping carrier, such as fedex, dhl_express, stamps_com, etc.

carrier_nicknamestring required

carrier nickname

carrier_friendly_namestring required

carrier friendly name

validation_status'valid' | 'invalid' | 'has_warnings' | 'unknown' required

The possible validation status values

warning_messagesstring[] required

The warning messages

error_messagesstring[] required

The error messages

rate_attributesRateAttributes[]

Optional attributes that indicate the most profitable rates

Example response

[
  {
    "carrier_id": "se-28529731",
    "zone": 6,
    "package_type": "package",
    "delivery_days": 5,
    "estimated_delivery_date": "2018-09-23T00:00:00.000Z"
  }
]

Changes

  • 6af91511d87eRevision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

  • 2c019e9a32d2Revision changes
    • info

      added the new age_verification_16_plus enum value to the request property //

    • info

      added the new delivery_code enum value to the request property //