v1

latestOpenAPI 3.0.02026-07-1397337495.2 KB

rates

Get Bulk Rates

Get Bulk Shipment Rates

post/v1/rates/bulk

Request body

Example request

{
  "rate_options": {
    "carrier_ids": [
      "se-28529731"
    ]
  }
}

Response

The request was a success.

rate_request_idstring required

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

shipment_idstring required

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

created_atstring date-time required

An ISO 8601 string that represents a date and time.

status'working' | 'completed' | 'partial' | 'error' required

The possible rate response status values

Example response

[
  {
    "rate_request_id": "se-28529731",
    "shipment_id": "se-28529731",
    "created_at": "2018-09-23T15:00:00.000Z",
    "errors": [
      {
        "message": "Body of request cannot be null.",
        "carrier_id": "se-28529731",
        "carrier_code": "dhl_express",
        "field_name": "shipment.ship_to.phone_number"
      }
    ]
  }
]