shipments

Get shipment rates

Get Rates for the shipment information associated with the shipment ID

get/v2/shipments/{shipment_id}/rates

Request

  • Base URL: https://api.shipstation.com
  • URL: https://api.shipstation.com/v2/shipments/{shipment_id}/rates
  • Auth: API key in header api-key

Query parameters

created_at_startstring date-time

Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)

Response

The request was a success.

rate_request_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

shipment_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

created_atstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

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

The possible rate response status values

Example response

{
  "rates": [
    {
      "rate_id": "se-28529731",
      "carrier_id": "se-28529731",
      "shipping_amount": {
        "amount": 12
      },
      "insurance_amount": {
        "amount": 12
      },
      "confirmation_amount": {
        "amount": 12
      },
      "other_amount": {
        "amount": 12
      },
      "requested_comparison_amount": {
        "amount": 12
      },
      "tax_amount": {
        "amount": 12
      },
      "zone": 6,
      "package_type": "package",
      "delivery_days": 5,
      "guaranteed_service": true,
      "estimated_delivery_date": "2018-09-23",
      "carrier_delivery_days": "22",
      "ship_date": "10/22/2024z00:00",
      "negotiated_rate": true,
      "service_type": "next_day",
      "service_code": "usps_priority_mail_express",
      "trackable": true,
      "carrier_code": "stamps_com",
      "carrier_nickname": "Free",
      "carrier_friendly_name": "free"
    }
  ],
  "invalid_rates": [
    {
      "rate_id": "se-28529731",
      "carrier_id": "se-28529731",
      "shipping_amount": {
        "amount": 12
      },
      "insurance_amount": {
        "amount": 12
      },
      "confirmation_amount": {
        "amount": 12
      },
      "other_amount": {
        "amount": 12
      },
      "requested_comparison_amount": {
        "amount": 12
      },
      "tax_amount": {
        "amount": 12
      },
      "zone": 6,
      "package_type": "package",
      "delivery_days": 5,
      "guaranteed_service": true,
      "estimated_delivery_date": "2018-09-23",
      "carrier_delivery_days": "22",
      "ship_date": "10/22/2024z00:00",
      "negotiated_rate": true,
      "service_type": "next_day",
      "service_code": "usps_priority_mail_express",
      "trackable": true,
      "carrier_code": "stamps_com",
      "carrier_nickname": "Free",
      "carrier_friendly_name": "free"
    }
  ],
  "rate_request_id": "se-28529731",
  "shipment_id": "se-28529731",
  "created_at": "se-28529731",
  "errors": [
    {
      "message": "Body of request cannot be null."
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.