# Get shipment rates

Get Rates for the shipment information associated with the shipment ID

Endpoint: GET /v1/shipments/{shipment_id}/rates
Version: 1.1.202604070904
Security: api_key

## Path parameters:

  - `shipment_id` (string, required)
    Shipment ID
    Example: "se-28529731"

## Query parameters:

  - `created_at_start` (string)
    Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
    Example: "2019-03-12T19:24:13.657Z"

## Response 200 fields (application/json):

  - `rates` (array, required)
    An array of shipment rates

  - `rates.rate_id` (string, required)
    A string that uniquely identifies the rate
    Example: "se-28529731"

  - `rates.rate_type` (string, required)
    The possible rate type values
    Enum: "check", "shipment"

  - `rates.carrier_id` (string, required)
    A string that uniquely identifies the carrier
    Example: "se-28529731"

  - `rates.shipping_amount` (object, required)
    The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.

  - `rates.shipping_amount.currency` (string, required)
    The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html

  - `rates.shipping_amount.amount` (number, required)
    The monetary amount, in the specified currency.

  - `rates.insurance_amount` (object, required)
    The insurance amount.  Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.

  - `rates.confirmation_amount` (object, required)
    The confirmation amount.  Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.

  - `rates.other_amount` (object, required)
    Any other charges associated with this rate.  Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.

  - `rates.requested_comparison_amount` (object)
    The total shipping cost for the specified comparison_rate_type.

  - `rates.tax_amount` (object)
    Tariff and additional taxes associated with an international shipment.

  - `rates.rate_details` (array)
    A list of rate details that are associated with this rate. This is useful for
displaying a breakdown of the rate to the user.

  - `rates.rate_details.rate_detail_type` (string)
    The possible rate detail type values
    Enum: "uncategorized", "shipping", "insurance", "confirmation", "discount", "fuel_charge", "additional_fees", "tariff", "tax", "delivery", "handling", "special_goods", "pickup", "location_fee", "oversize", "returns", "notifications", "tip", "duties_and_taxes", "brokerage_fee", "admin_fee", "adjustment"

  - `rates.rate_details.carrier_description` (string)
    A rate detail description defined by a carrier

  - `rates.rate_details.carrier_billing_code` (string)
    A rate detail code defined by a carrier

  - `rates.rate_details.carrier_memo` (string)
    Contains any additional information

  - `rates.rate_details.amount` (object)
    A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.

  - `rates.rate_details.rate_detail_attributes` (object)
    If applicable, contains additional data about a rate detail of a specific type, e.g. VAT

  - `rates.rate_details.rate_detail_attributes.tax_type` (string)
    Type of a tax added to shipping cost
    Enum: "vat"

  - `rates.rate_details.rate_detail_attributes.tax_percentage` (number)
    Tax percentage, e.g. 20 for 20%, added to the shipping cost

  - `rates.rate_details.billing_source` (string)
    The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance

  - `rates.zone` (integer,null, required)
    Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of
custom zones that vary depending upon the ship_to and ship_from location
    Example: 6

  - `rates.package_type` (string,null, required)
    package type that this rate was estimated for
    Example: "package"

  - `rates.delivery_days` (integer)
    The number of days estimated for delivery, this will show the _actual_ delivery
time if for example, the package gets shipped on a Friday
    Example: 5

  - `rates.guaranteed_service` (boolean, required)
    Indicates if the rate is guaranteed.

  - `rates.estimated_delivery_date` (string)
    An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time.  The value _may_ contain a time component, but it will be set to 00:00:00 UTC by ShipEngine.
    Example: "2018-09-23T00:00:00.000Z"

  - `rates.carrier_delivery_days` (string)
    The carrier delivery days

  - `rates.ship_date` (string)
    ship date

  - `rates.negotiated_rate` (boolean, required)
    Indicates if the rates been negotiated

  - `rates.service_type` (string, required)
    service type

  - `rates.service_code` (string, required)
    service code for the rate

  - `rates.trackable` (boolean, required)
    Indicates if rate is trackable

  - `rates.carrier_code` (string, required)
    carrier code

  - `rates.carrier_nickname` (string, required)
    carrier nickname

  - `rates.carrier_friendly_name` (string, required)
    carrier friendly name

  - `rates.validation_status` (string, required)
    The possible validation status values
    Enum: "valid", "invalid", "has_warnings", "unknown"

  - `rates.warning_messages` (array, required)
    The warning messages

  - `rates.error_messages` (array, required)
    The error messages

  - `rates.rate_attributes` (array)
    Optional attributes that indicate the most profitable rates

  - `invalid_rates` (array, required)
    An array of invalid shipment rates

  - `rate_request_id` (string, required)
    A string that uniquely identifies the rate request
    Example: "se-28529731"

  - `shipment_id` (string, required)
    A string that uniquely identifies the shipment
    Example: "se-28529731"

  - `created_at` (string, required)
    When the rate was created
    Example: "se-28529731"

  - `status` (string, required)
    The possible rate response status values
    Enum: "working", "completed", "partial", "error"

  - `errors` (array, required)

  - `errors.error_source` (string, required)
    The source of the error, as indicated by the name this informs us if the API call failed because of the
carrier, the order source, or the ShipEngine API itself.
    Enum: "carrier", "order_source", "shipengine"

  - `errors.error_type` (string, required)
    The type of error
    Enum: "account_status", "business_rules", "validation", "security", "system", "integrations"

  - `errors.error_code` (string, required)
    The error code specified for the failed API Call
    Enum: "auto_fund_not_supported", "batch_cannot_be_modified", "carrier_conflict", "carrier_disconnected", "carrier_not_connected", "carrier_not_supported", "confirmation_not_supported", "default_warehouse_cannot_be_deleted", "field_conflict", "field_value_required", "forbidden", "identifier_conflict", "identifiers_must_match", "insufficient_funds", "invalid_address", "invalid_billing_plan", "invalid_field_value", "invalid_identifier", "invalid_status", "invalid_string_length", "label_images_not_supported", "meter_failure", "order_source_not_active", "rate_limit_exceeded", "refresh_not_supported", "request_body_required", "return_label_not_supported", "settings_not_supported", "subscription_inactive", "terms_not_accepted", "tracking_not_supported", "trial_expired", "unauthorized", "unknown", "unspecified", "verification_failure", "warehouse_conflict", "webhook_event_type_conflict", "customs_items_required", "incompatible_paired_labels", "invalid_charge_event", "invalid_object", "no_rates_returned", "file_not_found", "shipping_rule_not_found", "service_not_determined", "no_rates_returned", "funding_source_registration_in_progress", "insurance_failure", "funding_source_missing_configuration", "funding_source_error"

  - `errors.message` (string, required)
    An error message associated with the failed API call
    Example: "Body of request cannot be null."

  - `errors.carrier_id` (string)
    A string that uniquely identifies the carrier that generated the error.
    Example: "se-28529731"

  - `errors.carrier_code` (string)
    The name of the shipping carrier that generated the error, such as fedex, dhl_express, stamps_com, etc.
    Example: "dhl_express"

  - `errors.field_name` (string)
    The name of the field that caused the error
    Example: "shipment.ship_to.phone_number"

## Response 400 fields (application/json):

  - `request_id` (string, required)
    A UUID that uniquely identifies the request id.
This can be given to the support team to help debug non-trivial issues that may occur
    Example: "aa3d8e8e-462b-4476-9618-72db7f7b7009"

  - `errors` (array, required)
    The errors associated with the failed API call

  - `errors.error_source` (string, required)
    The source of the error, as indicated by the name this informs us if the API call failed because of the
carrier, the order source, or the ShipEngine API itself.
    Enum: "carrier", "order_source", "shipengine"

  - `errors.error_type` (string, required)
    The type of error
    Enum: "account_status", "business_rules", "validation", "security", "system", "integrations"

  - `errors.error_code` (string, required)
    The error code specified for the failed API Call
    Enum: "auto_fund_not_supported", "batch_cannot_be_modified", "carrier_conflict", "carrier_disconnected", "carrier_not_connected", "carrier_not_supported", "confirmation_not_supported", "default_warehouse_cannot_be_deleted", "field_conflict", "field_value_required", "forbidden", "identifier_conflict", "identifiers_must_match", "insufficient_funds", "invalid_address", "invalid_billing_plan", "invalid_field_value", "invalid_identifier", "invalid_status", "invalid_string_length", "label_images_not_supported", "meter_failure", "order_source_not_active", "rate_limit_exceeded", "refresh_not_supported", "request_body_required", "return_label_not_supported", "settings_not_supported", "subscription_inactive", "terms_not_accepted", "tracking_not_supported", "trial_expired", "unauthorized", "unknown", "unspecified", "verification_failure", "warehouse_conflict", "webhook_event_type_conflict", "customs_items_required", "incompatible_paired_labels", "invalid_charge_event", "invalid_object", "no_rates_returned", "file_not_found", "shipping_rule_not_found", "service_not_determined", "no_rates_returned", "funding_source_registration_in_progress", "insurance_failure", "funding_source_missing_configuration", "funding_source_error"

  - `errors.message` (string, required)
    An error message associated with the failed API call
    Example: "Body of request cannot be null."

  - `errors.carrier_id` (string)
    A string that uniquely identifies the carrier that generated the error.
    Example: "se-28529731"

  - `errors.carrier_code` (string)
    The name of the shipping carrier that generated the error, such as fedex, dhl_express, stamps_com, etc.
    Example: "dhl_express"

  - `errors.field_name` (string)
    The name of the field that caused the error
    Example: "shipment.ship_to.phone_number"

## Response 404 fields (application/json):

  - `request_id` (string, required)
    A UUID that uniquely identifies the request id.
This can be given to the support team to help debug non-trivial issues that may occur
    Example: "aa3d8e8e-462b-4476-9618-72db7f7b7009"

  - `errors` (array, required)
    The errors associated with the failed API call

  - `errors.error_source` (string, required)
    The source of the error, as indicated by the name this informs us if the API call failed because of the
carrier, the order source, or the ShipEngine API itself.
    Enum: "carrier", "order_source", "shipengine"

  - `errors.error_type` (string, required)
    The type of error
    Enum: "account_status", "business_rules", "validation", "security", "system", "integrations"

  - `errors.error_code` (string, required)
    The error code specified for the failed API Call
    Enum: "auto_fund_not_supported", "batch_cannot_be_modified", "carrier_conflict", "carrier_disconnected", "carrier_not_connected", "carrier_not_supported", "confirmation_not_supported", "default_warehouse_cannot_be_deleted", "field_conflict", "field_value_required", "forbidden", "identifier_conflict", "identifiers_must_match", "insufficient_funds", "invalid_address", "invalid_billing_plan", "invalid_field_value", "invalid_identifier", "invalid_status", "invalid_string_length", "label_images_not_supported", "meter_failure", "order_source_not_active", "rate_limit_exceeded", "refresh_not_supported", "request_body_required", "return_label_not_supported", "settings_not_supported", "subscription_inactive", "terms_not_accepted", "tracking_not_supported", "trial_expired", "unauthorized", "unknown", "unspecified", "verification_failure", "warehouse_conflict", "webhook_event_type_conflict", "customs_items_required", "incompatible_paired_labels", "invalid_charge_event", "invalid_object", "no_rates_returned", "file_not_found", "shipping_rule_not_found", "service_not_determined", "no_rates_returned", "funding_source_registration_in_progress", "insurance_failure", "funding_source_missing_configuration", "funding_source_error"

  - `errors.message` (string, required)
    An error message associated with the failed API call
    Example: "Body of request cannot be null."

  - `errors.carrier_id` (string)
    A string that uniquely identifies the carrier that generated the error.
    Example: "se-28529731"

  - `errors.carrier_code` (string)
    The name of the shipping carrier that generated the error, such as fedex, dhl_express, stamps_com, etc.
    Example: "dhl_express"

  - `errors.field_name` (string)
    The name of the field that caused the error
    Example: "shipment.ship_to.phone_number"

## Response 500 fields (application/json):

  - `request_id` (string, required)
    A UUID that uniquely identifies the request id.
This can be given to the support team to help debug non-trivial issues that may occur
    Example: "aa3d8e8e-462b-4476-9618-72db7f7b7009"

  - `errors` (array, required)
    The errors associated with the failed API call

  - `errors.error_source` (string, required)
    The source of the error, as indicated by the name this informs us if the API call failed because of the
carrier, the order source, or the ShipEngine API itself.
    Enum: "carrier", "order_source", "shipengine"

  - `errors.error_type` (string, required)
    The type of error
    Enum: "account_status", "business_rules", "validation", "security", "system", "integrations"

  - `errors.error_code` (string, required)
    The error code specified for the failed API Call
    Enum: "auto_fund_not_supported", "batch_cannot_be_modified", "carrier_conflict", "carrier_disconnected", "carrier_not_connected", "carrier_not_supported", "confirmation_not_supported", "default_warehouse_cannot_be_deleted", "field_conflict", "field_value_required", "forbidden", "identifier_conflict", "identifiers_must_match", "insufficient_funds", "invalid_address", "invalid_billing_plan", "invalid_field_value", "invalid_identifier", "invalid_status", "invalid_string_length", "label_images_not_supported", "meter_failure", "order_source_not_active", "rate_limit_exceeded", "refresh_not_supported", "request_body_required", "return_label_not_supported", "settings_not_supported", "subscription_inactive", "terms_not_accepted", "tracking_not_supported", "trial_expired", "unauthorized", "unknown", "unspecified", "verification_failure", "warehouse_conflict", "webhook_event_type_conflict", "customs_items_required", "incompatible_paired_labels", "invalid_charge_event", "invalid_object", "no_rates_returned", "file_not_found", "shipping_rule_not_found", "service_not_determined", "no_rates_returned", "funding_source_registration_in_progress", "insurance_failure", "funding_source_missing_configuration", "funding_source_error"

  - `errors.message` (string, required)
    An error message associated with the failed API call
    Example: "Body of request cannot be null."

  - `errors.carrier_id` (string)
    A string that uniquely identifies the carrier that generated the error.
    Example: "se-28529731"

  - `errors.carrier_code` (string)
    The name of the shipping carrier that generated the error, such as fedex, dhl_express, stamps_com, etc.
    Example: "dhl_express"

  - `errors.field_name` (string)
    The name of the field that caused the error
    Example: "shipment.ship_to.phone_number"