Sign in

v1

latestOpenAPI 3.0.02026-07-1397337495.2 KB
shipments

Get Shipment Rates

Get Rates for the shipment information associated with the shipment ID

get/v1/shipments/{shipment_id}/rates

Query parameters

created_at_startstring date-time

Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)

Response

The request was a success.

rate_request_idstring

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

shipment_idstring

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

created_atstring

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

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

The possible rate response status values

Example response

{
  "rates": [
    {
      "rate_id": "se-28529731",
      "carrier_id": "se-28529731",
      "zone": 6,
      "package_type": "package",
      "delivery_days": 5,
      "estimated_delivery_date": "2018-09-23T00:00:00.000Z"
    }
  ],
  "invalid_rates": [
    {
      "rate_id": "se-28529731",
      "carrier_id": "se-28529731",
      "zone": 6,
      "package_type": "package",
      "delivery_days": 5,
      "estimated_delivery_date": "2018-09-23T00:00:00.000Z"
    }
  ],
  "rate_request_id": "se-28529731",
  "shipment_id": "se-28529731",
  "created_at": "se-28529731",
  "errors": [
    {
      "message": "Body of request cannot be null.",
      "carrier_id": "se-28529731",
      "carrier_code": "dhl_express",
      "field_name": "shipment.ship_to.phone_number"
    }
  ]
}