API ReferenceDocs
API Reference
Dashboard
These docs are for v2023.01. Click to read the latest docs for v2024.09.

Request Rates

post
https://api.easyship.com/2023-01/rates

Request a list of shipping quotes for a prospective shipment.

Required authorization scope: Rate

Compare couriers to see the cheapest, fastest and best value for money, or a combination of speed, price and reliability.

Input city and state

If you are shipping to or within the United States, Canada, Mexico or Australia, we recommend that you always input the origin and destination city and state. This information is required by certain couriers to return accurate rates.

Calculate dimensions and total weight

You can calculate dimensions and total weight of your shipment in three ways:

  • Provide total_actual_weight and box objects for the shipment.
  • Specify actual_weight and dimensions for each item of the items object: in this case, total weight and box size will be calculated automatically.
  • Specify sku for each item of the items object: in this case, actual weight and dimensions for calculations will be taken as set for the product.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
origin_address
object
required

Origin Address

destination_address
object
required

Destination Address

string | null
enum
Defaults to DDU

Terms of Sale

Allowed:
insurance
object | null

Insurance

boolean

Set the shipment as a return shipment

courier_selection
object
shipping_settings
object
parcels
array of objects
required
length ≥ 1

Parcels

parcels*
number

Total weight of the shipment, including the box weight. If you provide the total weight of the shipment, then the weight for items can be optional.

box
object | null

The box dimensions for the shipment. If the box dimensions are provided, then dimensions for items are optional.

items
array
length between 1 and 200

Array of all shipment items

items
string
≤ 200

Description of the item

string | null
≤ 200

Item category name or slug. Use the Item Categories API to retrieve a list of available item categories.

string
≤ 100

Item Stock Keeping Unit (SKU) as listed in your store.

string

HS Code of the item

boolean | null

Whether the item contains a PI966 battery (applicable when HS code is used).

boolean | null

Whether the item contains a PI967 battery (applicable when HS code is used).

boolean | null

Whether the item contains liquids (applicable when HS code is used).

string | null
enum

Country Code in Alpha-2 format (ISO 3166-1)

integer
Defaults to 1

Item quantity

dimensions
object

Dimensions of the item

number

Item actual weight in kg, must be greater than 0; Optional if total_actual_weight is provided.

string
enum

Item currency. ISO-4217 three-letter alphabetic currency code (e.g. USD, EUR, GBP).

number

Item customs value, must be greater than 0 unless category is documents.

filter_options
object

Filter response by keywords

Responses

Updated 10 months ago

Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago