Retrieve Shipping Rates

GET

/shipping/rates/{allocation_id}

Fetch shipping rates based on the provided parameters.

Parameters

Path Parameters

allocation_id

required

number

The ID of the allocation of the order to retrieve shipping rates for.

Query Parameters

from_allocation_package

required

boolean

Must be set to true. Specifies whether to use dimensions from the already existing allocation package.

format_with_unavailable_quotes

boolean

Whether to include unavailable rates in the response. Defaults to false.

Responses

200

Successful response with shipping rates.

A list of shipping rates available and unavailable for the specified allocation.

object

available

List of available shipping rates.

Array<shipping_rate>

object

carrier

string

amazon_shipping_v2

service_carrier

The service carrier for the shipping rate.

string

ups

service_id

Internal ID for the shipping rate.

string

UPS_PTP_3DAY_SELECT

remote_shipment_id

Used to identify the shipping rate. Starts with prb.

string

prb35e7b5a4

name

Unique identifier for this specific rate. Starts with amazon_shipping_v2- followed by a UUID.

string

amazon_shipping_v2-2295c3aa-af8c-48a0-9f19-cd84d53cbd36

base_rate

The base cost for the shipping rate.

number format: float

currency

The currency in which the shipping rate is denominated.

string format: char

credits

Amount of Veeqo Credits to be earnt if this shipping rate is selected.

number format: float

cutoff

The time after which this shipping rate cannot be purchased.

string format: date-time

charges

Breakdown of charges associated with the shipping rate.

Array<charge>

object

charge_id

Name of the charge.

string

charge_title

Human-readable name of the charge.

string

price

Amount of the charge.

string format: currency

charge_type

Either “MANDATORY” or “OPTIONAL”.

string

delivery_promise_date

The estimated delivery date for the shipping rate.

string format: date-time

protected

Whether this rate is A-to-z/SAFE-T claims protected.

boolean

protections

List of protections this rate provides.

array

[
  "CLAIMS_PROTECTED",
  "OTDR_PROTECTED"
]

shipping_service_options

Additional options available for the shipping service, such as signature confirmation.

array

unavailable

List of unavailable shipping rates. If format_with_unavailable_quotes is set to false, this array will be empty.

Array<unavailable_shipping_rate>

object

remote_shipment_id

Used to identify the shipping rate.

string

prb35e7b5a4

title

Full title of the shipping rate.

string

sub_carrier_id

The sub-carrier ID for the shipping rate.

string

service_carrier

The service carrier for the shipping rate.

string

unavailable_reasons

Reasons why the shipping rate is unavailable.

Array<object>

A reason why the shipping rate is unavailable.

object

message

The reason for unavailability.

string

It is not an eligible ship method for this order.

linked_accounts

List of your own linked carrier accounts.

Array<linked_account>

object

shipping_configuration_id

The ID of the linked account.

number format: int64

carrier

The name of the linked account.

string

amazon_shipping_v2__FEDEX

Example

{
  "available": [
    {
      "carrier": "amazon_shipping_v2",
      "name": "amazon_shipping_v2-2295c3aa-af8c-48a0-9f19-cd84d53cbd36",
      "title": "UPS 3 Day Select®",
      "short_title": "UPS 3 Day Select®",
      "title_with_price": "UPS 3 Day Select® - $11.80",
      "total_net_charge": "11.80",
      "total_gross_charge": "11.80",
      "base_rate": "11.80",
      "charges": [
        {
          "price": "$11.80",
          "charge_id": "BASE_RATE",
          "charge_title": "Base Rate",
          "charge_type": "MANDATORY"
        },
        {
          "price": "$5.90",
          "charge_id": "SIGNATURE_CONFIRMATION",
          "charge_title": "Signature confirmation",
          "charge_type": "OPTIONAL"
        },
        {
          "price": "$7.10",
          "charge_id": "ADULT_SIGNATURE_CONFIRMATION",
          "charge_title": "Adult signature confirmation",
          "charge_type": "OPTIONAL"
        }
      ],
      "currency": "$",
      "weight": "1550.9999986993",
      "remote_shipment_id": "prb123abcde",
      "cutoff": "2025-06-10T22:00:00+01:00",
      "mailpiece_shapes": null,
      "liability_amount": null,
      "expected_delivery_days": 4,
      "sub_carrier_id": "UPS",
      "service_carrier": "ups",
      "shipping_service_options": [
        {
          "key": "value_added_service__VAS_GROUP_ID_CONFIRMATION",
          "label": "Confirmation",
          "type": "select",
          "multiple": false,
          "values": [
            {
              "value": "NO_CONFIRMATION",
              "label": "No confirmation",
              "price": 0,
              "currency": "USD"
            },
            {
              "value": "SIGNATURE_CONFIRMATION",
              "label": "Signature confirmation",
              "price": 5.9,
              "currency": "USD"
            },
            {
              "value": "ADULT_SIGNATURE_CONFIRMATION",
              "label": "Adult signature confirmation",
              "price": 7.1,
              "currency": "USD"
            }
          ],
          "validation": null,
          "unit": null,
          "default": null
        },
        {
          "key": "liability_amount",
          "label": "Insurance",
          "type": "number",
          "multiple": false,
          "values": [],
          "validation": {
            "min": 100,
            "max": 50000
          },
          "unit": "USD",
          "default": null
        },
        {
          "key": "try_inbound_label",
          "label": "Create Return Label",
          "type": "boolean",
          "multiple": false,
          "values": [],
          "validation": null,
          "unit": null,
          "default": null
        }
      ],
      "warnings": [],
      "hidden": false,
      "other": {},
      "pickup_window": {
        "end": null,
        "start": null
      },
      "own_account": false,
      "expires_at": "2025-06-10T21:59:59.332Z",
      "delivery_promise_date": "2025-06-14T07:59:59+01:00",
      "meets_delivery_promise": null,
      "protected": null,
      "protections": null,
      "additional_content": null,
      "credits": 0.059,
      "service_id": "UPS_PTP_3DAY_SELECT",
      "document_specification": {
        "doc_spec": {
          "format": "PNG",
          "printOptions": [
            {
              "supportedDPIs": [],
              "supportedDocumentDetails": [
                {
                  "isMandatory": true,
                  "name": "LABEL"
                }
              ],
              "supportedFileJoiningOptions": [
                true
              ],
              "supportedPageLayouts": [
                "LEFT"
              ]
            }
          ],
          "size": {
            "length": 6,
            "unit": "INCH",
            "width": 4
          }
        }
      }
    }
  ],
  "unavailable": [
    {
      "remote_shipment_id": "prb35e7b5a4",
      "title": "UPS Next Day Air®",
      "sub_carrier_id": "UPS",
      "service_carrier": "ups",
      "unavailable_reasons": [
        {
          "message": "It is not an eligible ship method for this order."
        }
      ]
    }
  ],
  "linked_accounts": [
    {
      "shipping_configuration_id": 123456,
      "carrier": "amazon_shipping_v2__FEDEX"
    }
  ]
}

404

Allocation ID is incorrect. Ensure you are passing an allocation ID, not an order ID.

500

Internal server error. This could be the result of not including from_allocation_package=true in the request.