--- title: "Get Shipment Rates" method: GET path: "/v1/shipments/{shipment_id}/rates" tags: ["shipments"] --- # Get Shipment Rates `GET /v1/shipments/{shipment_id}/rates` Get Rates for the shipment information associated with the shipment ID ## Query parameters - `created_at_start` string, date-time ## Response `200` The request was a success. - ListShipmentRatesResponseBody — A rates information resource - `rates` object[] — An array of shipment rates - `rate_id` string, required — A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. - `rate_type` 'check' | 'shipment', required — The possible rate type values - `carrier_id` string, required — A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. - `shipping_amount` MonetaryValue, required — A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. - `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 - `amount` number, required — The monetary amount, in the specified currency. - `insurance_amount` MonetaryValue, required — A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. - `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 - `amount` number, required — The monetary amount, in the specified currency. - `confirmation_amount` MonetaryValue, required — A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. - `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 - `amount` number, required — The monetary amount, in the specified currency. - `other_amount` MonetaryValue, required — A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. - `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 - `amount` number, required — The monetary amount, in the specified currency. - `requested_comparison_amount` MonetaryValue — A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. - `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 - `amount` number, required — The monetary amount, in the specified currency. - `tax_amount` MonetaryValue — A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. - `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 - `amount` number, required — The monetary amount, in the specified currency. - `rate_details` RateDetail[] — A list of rate details that are associated with this rate. This is useful for displaying a breakdown of the rate to the user. - `rate_detail_type` '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' — The possible rate detail type values - `carrier_description` string — A rate detail description defined by a carrier - `carrier_billing_code` string — A rate detail code defined by a carrier - `carrier_memo` string — Contains any additional information - `amount` MonetaryValue — A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. - `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 - `amount` number, required — The monetary amount, in the specified currency. - `rate_detail_attributes` RateDetailAttributes — Represents detailed information about a tax (e.g. VAT) contained in a shipping cost. - `tax_type` 'vat' — Type of a tax added to shipping cost - `tax_percentage` number — Tax percentage, e.g. 20 for 20%, added to the shipping cost - `billing_source` string — The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance - `zone` integer, nullable, 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 - `package_type` string, nullable, required — package type that this rate was estimated for - `delivery_days` integer, nullable — The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday - `guaranteed_service` boolean, required — Indicates if the rate is guaranteed. - `estimated_delivery_date` string, date-time — 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. - `carrier_delivery_days` string — The carrier delivery days - `ship_date` string, date-time — ship date - `negotiated_rate` boolean, required — Indicates if the rates been negotiated - `service_type` string, required — service type - `service_code` string, required — service code for the rate - `trackable` boolean, required — Indicates if rate is trackable - `carrier_code` string, required — carrier code - `carrier_nickname` string, required — carrier nickname - `carrier_friendly_name` string, required — carrier friendly name - `validation_status` 'valid' | 'invalid' | 'has_warnings' | 'unknown', required — The possible validation status values - `warning_messages` string[], required — The warning messages - `error_messages` string[], required — The error messages - `rate_attributes` RateAttributes[] — Optional attributes that indicate the most profitable rates - `invalid_rates` Rate[] — An array of invalid shipment rates - `rate_id` string, required — A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. - `rate_type` 'check' | 'shipment', required — The possible rate type values - `carrier_id` string, required — A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. - `shipping_amount` MonetaryValue, required — A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. - `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 - `amount` number, required — The monetary amount, in the specified currency. - `insurance_amount` MonetaryValue, required — A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. - `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 - `amount` number, required — The monetary amount, in the specified currency. - `confirmation_amount` MonetaryValue, required — A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. - `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 - `amount` number, required — The monetary amount, in the specified currency. - `other_amount` MonetaryValue, required — A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. - `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 - `amount` number, required — The monetary amount, in the specified currency. - `requested_comparison_amount` MonetaryValue — A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. - `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 - `amount` number, required — The monetary amount, in the specified currency. - `tax_amount` MonetaryValue — A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. - `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 - `amount` number, required — The monetary amount, in the specified currency. - `rate_details` RateDetail[] — A list of rate details that are associated with this rate. This is useful for displaying a breakdown of the rate to the user. - `rate_detail_type` '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' — The possible rate detail type values - `carrier_description` string — A rate detail description defined by a carrier - `carrier_billing_code` string — A rate detail code defined by a carrier - `carrier_memo` string — Contains any additional information - `amount` MonetaryValue — A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. - `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 - `amount` number, required — The monetary amount, in the specified currency. - `rate_detail_attributes` RateDetailAttributes — Represents detailed information about a tax (e.g. VAT) contained in a shipping cost. - `tax_type` 'vat' — Type of a tax added to shipping cost - `tax_percentage` number — Tax percentage, e.g. 20 for 20%, added to the shipping cost - `billing_source` string — The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance - `zone` integer, nullable, 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 - `package_type` string, nullable, required — package type that this rate was estimated for - `delivery_days` integer, nullable — The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday - `guaranteed_service` boolean, required — Indicates if the rate is guaranteed. - `estimated_delivery_date` string, date-time — 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. - `carrier_delivery_days` string — The carrier delivery days - `ship_date` string, date-time — ship date - `negotiated_rate` boolean, required — Indicates if the rates been negotiated - `service_type` string, required — service type - `service_code` string, required — service code for the rate - `trackable` boolean, required — Indicates if rate is trackable - `carrier_code` string, required — carrier code - `carrier_nickname` string, required — carrier nickname - `carrier_friendly_name` string, required — carrier friendly name - `validation_status` 'valid' | 'invalid' | 'has_warnings' | 'unknown', required — The possible validation status values - `warning_messages` string[], required — The warning messages - `error_messages` string[], required — The error messages - `rate_request_id` string — A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. - `shipment_id` string — A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. - `created_at` string — 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 - `errors` Error[] - `error_source` 'carrier' | 'order_source' | 'shipengine', 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. - `error_type` 'account_status' | 'business_rules' | 'validation' | 'security' | 'system' | 'integrations', required — The type of error - `error_code` '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', required — The error code specified for the failed API Call - `message` string, required — An error message associated with the failed API call - `carrier_id` string — A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. - `carrier_code` string — A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. - `field_name` string — The name of the field that caused the error ## Other responses - `400` — The request contained errors. - `404` — The specified resource does not exist. - `500` — An error occurred on ShipEngine's side. > This error will automatically be reported to our engineers. --- [API](https://skmtc.net/shipengine/apis/shipengine-api.md) · [All operations](https://skmtc.net/shipengine/apis/shipengine-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipengine/shipengine-api/revisions/6af91511d87e/schema)