rates

Get Bulk Shipment Rates

post/v1/rates/bulk

Request

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

Request body

Example request

{
  "rate_options": {
    "carrier_ids": [
      "se-28529731"
    ],
    "preferred_currency": "USD"
  }
}

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": [
      {
        "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 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

    • info

      added the new optional request property ///////

    • breaking

      added the new required request property ////////

    • breaking

      added the new required request property ////////

    • breaking

      added the new required request property ////////

    • breaking

      added the new required request property ////////

    • breaking

      added the new required request property ////////

    • breaking

      added the new required request property ///////

    • breaking

      added the new required request property ///////

    • breaking

      added the new required request property ///////

    • breaking

      added the new required request property ///////

    • breaking

      added the new required request property ///////

    • breaking

      added the new required request property ///////

    • breaking

      request property //////// was restricted to a list of enum values

    • breaking

      request property ///////// was restricted to a list of enum values

    • breaking

      request property /////////// was restricted to a list of enum values

    • breaking

      request property ///// was restricted to a list of enum values

    • breaking

      request property /////// was restricted to a list of enum values

    • breaking

      the ////// request property's minLength was increased from 0 to 1

    • breaking

      the ///////// request property's minLength was increased from 0 to 1

    • breaking

      the ///////// request property's minLength was increased from 0 to 1

    • breaking

      the ///////// request property's minLength was increased from 0 to 1

    • breaking

      added the pattern ^se(-[a-z0-9]+)+$ to the request property //////

    • breaking

      the /// request property type changed from no type to string

    • breaking

      the ///////// request property type changed from no type to string

    • breaking

      the //////// request property type changed from no type to string

    • breaking

      the ///////// request property type changed from no type to string

    • breaking

      the ////// request property type changed from no type to string

    • breaking

      the /////////// request property type changed from no type to string

    • breaking

      the /////// request property type changed from no type to object

    • breaking

      the /////// request property type changed from no type to object

    • breaking

      the ////// request property type changed from no type to object

    • breaking

      the ///// request property type changed from no type to string

    • breaking

      the ////// request property type changed from no type to object

    • breaking

      the ///////// request property type changed from no type to string

    • breaking

      the ///////// request property type changed from no type to string

    • breaking

      the ///////// request property type changed from no type to string

    • breaking

      the ////// request property type changed from no type to object

    • breaking

      the ////// request property type changed from no type to object

    • breaking

      the /////// request property type changed from no type to string

    • 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 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

    • warning

      removed from the //////// request property allOf list

    • warning

      removed from the /// request property allOf list

    • warning

      removed from the ///////// request property allOf list

    • warning

      removed from the /////// request property allOf list

    • warning

      removed from the /////// request property allOf list

    • warning

      removed from the ///// request property allOf list

    • warning

      removed from the ////// request property allOf list

    • warning

      removed from the ///////// request property allOf list

    • warning

      removed from the ///////// request property allOf list

    • warning

      removed from the ///////// request property allOf list

    • warning

      removed from the ////// request property allOf list

    • warning

      removed from the ////// request property allOf list

    • warning

      removed from the ////// request property allOf list

    • warning

      removed from the ////// request property allOf list

    • warning

      removed from the ///////// request property allOf list

    • warning

      removed from the /////////// request property allOf list

    • warning

      removed from the /////// request property allOf list

    • warning

      the ////// request property's maxLength was set to 25

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new amazon_ca enum value to the request property /////

    • info

      added the new amazon_us enum value to the request property /////

    • info

      added the new any enum value to the request property ////////

    • info

      added the new brightpearl enum value to the request property /////

    • info

      added the new cash enum value to the request property ////////

    • info

      added the new cash_equivalent enum value to the request property ////////

    • info

      added the new channel_advisor enum value to the request property /////

    • info

      added the new cratejoy enum value to the request property /////

    • info

      added the new ebay enum value to the request property /////

    • info

      added the new etsy enum value to the request property /////

    • info

      added the new gram enum value to the request property /////////

    • info

      added the new gram enum value to the request property ///////////

    • info

      added the new gram enum value to the request property ///////

    • info

      added the new groupon_goods enum value to the request property /////

    • info

      added the new jane enum value to the request property /////

    • info

      added the new kilogram enum value to the request property /////////

    • info

      added the new kilogram enum value to the request property ///////////

    • info

      added the new kilogram enum value to the request property ///////

    • info

      added the new magento enum value to the request property /////

    • info

      added the new none enum value to the request property ////////

    • info

      added the new ounce enum value to the request property /////////

    • info

      added the new ounce enum value to the request property ///////////

    • info

      added the new ounce enum value to the request property ///////

    • info

      added the new paypal enum value to the request property /////

    • info

      added the new pound enum value to the request property /////////

    • info

      added the new pound enum value to the request property ///////////

    • info

      added the new pound enum value to the request property ///////

    • info

      added the new seller_active enum value to the request property /////

    • info

      added the new shopify enum value to the request property /////

    • info

      added the new squarespace enum value to the request property /////

    • info

      added the new stitch_labs enum value to the request property /////

    • info

      added the new three_dcart enum value to the request property /////

    • info

      added the new tophatter enum value to the request property /////

    • info

      added the new volusion enum value to the request property /////

    • info

      added the new walmart enum value to the request property /////

    • info

      added the new woo_commerce enum value to the request property /////

    • 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

      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