Easyship · Example Payload

Easyship Get Rates Example

Request multi-courier rate quotes for a shipment from Hong Kong to New York.

ShippingLogisticsEcommerceFulfillmentCrossBorder

Easyship Get Rates Example is an example object payload from Easyship, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

exampledescriptionrequestresponse

Example Payload

Raw ↑
{
  "example": "Request Shipping Rate Quotes",
  "description": "Request multi-courier rate quotes for a shipment from Hong Kong to New York.",
  "request": {
    "method": "POST",
    "url": "https://api.easyship.com/2024-09/rates",
    "headers": {
      "Authorization": "Bearer prod_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "Content-Type": "application/json"
    },
    "body": {
      "origin_address": {
        "line_1": "1 Hennessy Road",
        "city": "Wan Chai",
        "country_alpha2": "HK",
        "postal_code": "00000",
        "contact_name": "Jane Lee",
        "contact_phone": "+85225551234",
        "contact_email": "jane@example.com",
        "company_name": "Acme HK Ltd."
      },
      "destination_address": {
        "line_1": "350 5th Ave",
        "city": "New York",
        "state": "NY",
        "country_alpha2": "US",
        "postal_code": "10118",
        "contact_name": "John Doe",
        "contact_phone": "+12125559876",
        "contact_email": "john@example.com"
      },
      "parcels": [
        {
          "box": { "length": 20, "width": 15, "height": 10, "slug": "custom" },
          "total_actual_weight": 1.2
        }
      ],
      "items": [
        {
          "description": "Bluetooth Headphones",
          "quantity": 1,
          "actual_weight": 1.2,
          "declared_currency": "USD",
          "declared_customs_value": 79.0,
          "sku": "BT-HP-001",
          "hs_code": "8518.30.20",
          "origin_country_alpha2": "CN"
        }
      ]
    }
  },
  "response": {
    "status": 200,
    "body": {
      "rates": [
        {
          "courier_id": "00112233-4455-6677-8899-aabbccddeeff",
          "courier_name": "DHL Express Worldwide",
          "total_charge": 42.18,
          "currency": "USD",
          "min_delivery_time": 2,
          "max_delivery_time": 4,
          "value_for_money_rank": 3,
          "delivery_time_rank": 1,
          "incoterms": "DDP"
        },
        {
          "courier_id": "11223344-5566-7788-99aa-bbccddeeff00",
          "courier_name": "FedEx International Priority",
          "total_charge": 47.95,
          "currency": "USD",
          "min_delivery_time": 2,
          "max_delivery_time": 5,
          "value_for_money_rank": 4,
          "delivery_time_rank": 2,
          "incoterms": "DDP"
        },
        {
          "courier_id": "22334455-6677-8899-aabb-ccddeeff0011",
          "courier_name": "SF Express Economy",
          "total_charge": 21.40,
          "currency": "USD",
          "min_delivery_time": 6,
          "max_delivery_time": 10,
          "value_for_money_rank": 1,
          "delivery_time_rank": 5,
          "incoterms": "DDU"
        }
      ]
    }
  }
}