rates

Retrieve a previously queried rate by its ID

get/v1/rates/{rate_id}

Request

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

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 date-time

An ISO 8601 string that represents a date and time.

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

The possible rate response status values

Example response

{
  "rates": [
    {
      "rate_id": "se-28529731",
      "carrier_id": "se-28529731",
      "shipping_amount": {
        "currency": "USD"
      },
      "insurance_amount": {
        "currency": "USD"
      },
      "confirmation_amount": {
        "currency": "USD"
      },
      "other_amount": {
        "currency": "USD"
      },
      "requested_comparison_amount": {
        "currency": "USD"
      },
      "tax_amount": {
        "currency": "USD"
      },
      "rate_details": [
        {
          "carrier_description": "Shipping",
          "carrier_billing_code": "BaseServiceCharge",
          "amount": {
            "currency": "USD"
          },
          "rate_detail_attributes": {
            "tax_type": "vat"
          },
          "billing_source": "carrier"
        }
      ],
      "zone": 6,
      "package_type": "package",
      "delivery_days": 5,
      "estimated_delivery_date": "2018-09-23T00:00:00.000Z",
      "delivery_prediction": {
        "delivery_date": "2026-07-04",
        "confidence_level": "high"
      }
    }
  ],
  "invalid_rates": [
    {
      "rate_id": "se-28529731",
      "carrier_id": "se-28529731",
      "shipping_amount": {
        "currency": "USD"
      },
      "insurance_amount": {
        "currency": "USD"
      },
      "confirmation_amount": {
        "currency": "USD"
      },
      "other_amount": {
        "currency": "USD"
      },
      "requested_comparison_amount": {
        "currency": "USD"
      },
      "tax_amount": {
        "currency": "USD"
      },
      "rate_details": [
        {
          "carrier_description": "Shipping",
          "carrier_billing_code": "BaseServiceCharge",
          "amount": {
            "currency": "USD"
          },
          "rate_detail_attributes": {
            "tax_type": "vat"
          },
          "billing_source": "carrier"
        }
      ],
      "zone": 6,
      "package_type": "package",
      "delivery_days": 5,
      "estimated_delivery_date": "2018-09-23T00:00:00.000Z",
      "delivery_prediction": {
        "delivery_date": "2026-07-04",
        "confidence_level": "high"
      }
    }
  ],
  "rate_request_id": "se-28529731",
  "shipment_id": "se-28529731",
  "created_at": "2018-09-23T15:00:00.000Z",
  "errors": [
    {
      "error_source": "shipengine",
      "error_type": "validation",
      "error_code": "invalid_field_value",
      "message": "Body of request cannot be null.",
      "carrier_id": "se-28529731",
      "carrier_code": "dhl_express",
      "field_name": "shipment.ship_to.phone_number"
    }
  ]
}

Changes

    • warning

      added the new bring_your_own_label_not_supported enum value to the /// response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the /// response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the /// response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • breaking

      the // response's property type changed from no type to object for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • breaking

      the ///// response's property type changed from no type to string for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • warning

      added the new best_value enum value to the ///// response property for the response status

    • warning

      added the new cheapest enum value to the ///// response property for the response status

    • warning

      added the new fastest enum value to the ///// response property for the response status

    • warning

      added the new gram enum value to the ////// response property for the response status

    • warning

      added the new gram enum value to the ////// response property for the response status

    • warning

      added the new kilogram enum value to the ////// response property for the response status

    • warning

      added the new kilogram enum value to the ////// response property for the response status

    • warning

      added the new ounce enum value to the ////// response property for the response status

    • warning

      added the new ounce enum value to the ////// response property for the response status

    • warning

      added the new pound enum value to the ////// response property for the response status

    • warning

      added the new pound enum value to the ////// response property for the response status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status