--- title: "Get rate by id" method: GET path: "/v2/rates/{rate_id}" tags: ["rates"] --- # Get rate by id `GET /v2/rates/{rate_id}` Retrieve a previously queried rate by its ID ## Response `200` The request was a success. - GetRateByIdResponseBody — A rate - `rate_id` string, required — A string that uniquely identifies a ShipStation 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 ShipStation 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 ShipStation 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 ShipStation 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 ShipStation 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 ShipStation 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 ShipStation 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 ShipStation 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. - `zone` integer, 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, required — package type that this rate was estimated for - `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 - `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 ShipStation . - `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_details` object[] — A breakdown of individual charges that make up this rate, such as base shipping cost and additional fees. For DDP shipments it also includes duties, taxes, and import fees (prepaid on Wallet carriers, estimated on BYOA carriers). - `rate_detail_type` string — The category of charge. Common values include `shipping` and `additional_fees`. DDP shipments (`customs.terms_of_trade_code: ddp`) also return `prepaid_duties`, `prepaid_taxes` and `prepaid_import_fees` on Wallet carriers or `estimated_duties`, `estimated_taxes` and `estimated_import_fees` on BYOA (Bring Your Own Account) carriers. - `carrier_description` string — The carrier-provided description of the charge. - `carrier_billing_code` string — The carrier billing code, when provided by the carrier. - `carrier_memo` string — An optional carrier-supplied note for the charge. - `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 ShipStation 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. - `billing_source` string — The source that produced the charge. Common values are `carrier` for carrier-billed charges and `dutiestax` for duties and taxes on DDP shipments (prepaid on Wallet carriers, estimated on BYOA carriers). > **Note:** The casing of this value differs by endpoint. Label responses return lowercase values (e.g. `carrier`, `dutiestax`). Rate responses return PascalCase values (e.g. `Carrier`, `DutiesTax`). This reflects the actual API behavior. ## Other responses - `400` — The request contained errors. - `404` — The API returns a 404 response when no `rate` corresponds to the `rate_id` provided. - `500` — The request was successful. --- [API](https://skmtc.net/shipstation/apis/shipstation-api-v2.md) · [All operations](https://skmtc.net/shipstation/apis/shipstation-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipstation/shipstation-api-v2/revisions/d3d8c21cd227/schema)