Get shipping rates

POST

/shipping/api/v1/rates

Veeqo API Production Server

Retrieve available shipping rates for a shipment without creating an order. Returns shipping rate quotes from configured carriers (currently Amazon Shipping V2) based on shipment details.

Request Body^required

object

to_address

required

object

address_id

Veeqo Address Service ID

string

letterbox-abc-123

name

Recipient/sender name

string

John Doe

company

Company name

string

Acme Corp

phone

Phone number (auto-formatted to E.164)

string

+12065551234

email

Email address

string format: email

john.doe@example.com

line1

Address line 1

string

123 Main St

line2

Address line 2

string

Apt 4B

town

City/town

string

Seattle

postcode

Postal/ZIP code

string

country_code

ISO 3166-1 alpha-2 country code

string

US

county

State/region/county

string

WA

from_address

required

object

address_id

Veeqo Address Service ID

string

letterbox-abc-123

name

Recipient/sender name

string

John Doe

company

Company name

string

Acme Corp

phone

Phone number (auto-formatted to E.164)

string

+12065551234

email

Email address

string format: email

john.doe@example.com

line1

Address line 1

string

123 Main St

line2

Address line 2

string

Apt 4B

town

City/town

string

Seattle

postcode

Postal/ZIP code

string

country_code

ISO 3166-1 alpha-2 country code

string

US

county

State/region/county

string

WA

return_address

object

address_id

Veeqo Address Service ID

string

letterbox-abc-123

name

Recipient/sender name

string

John Doe

company

Company name

string

Acme Corp

phone

Phone number (auto-formatted to E.164)

string

+12065551234

email

Email address

string format: email

john.doe@example.com

line1

Address line 1

string

123 Main St

line2

Address line 2

string

Apt 4B

town

City/town

string

Seattle

postcode

Postal/ZIP code

string

country_code

ISO 3166-1 alpha-2 country code

string

US

county

State/region/county

string

WA

parcels

required

Array of parcels (currently only 1 parcel supported)

Array<object>

>= 1 items <= 1 items

object

weight

required

Parcel weight (must be > 0)

number format: double

>= 0.01

1.5

weight_unit

required

Weight unit

string

Allowed values: oz lb g kg

lb

height

Parcel height

number format: double

width

Parcel width

number format: double

length

Parcel length

number format: double

dimension_unit

Dimension unit

string

Allowed values: in cm ft m

in

hazmat

Hazardous materials indicator

boolean

customer_reference

Your reference number for this shipment.

IMPORTANT: For Amazon orders (is_amazon_order: true), this MUST be the Amazon order number (e.g., “112-4737182-6879466”). This is required to enable Buy Shipping protections.

string

112-4737182-6879466

contents

Package contents description

string

Electronics

estimated_value

Shipment value for insurance/customs

string

25.00

currency_code

ISO 4217 currency code

string

USD

customer_type

Customer type

string

default: consumer

Allowed values: consumer business

is_amazon_order

Set to true for Amazon orders to enable protections

boolean

seller_display_name

Your store/seller name to display on shipping labels

string

My Store Name

preferred_shipment_date

ISO 8601 datetime

string format: date-time

2025-10-01T12:00:00Z

due_date

ISO 8601 datetime

string format: date-time

2025-10-05T12:00:00Z

liability_amount

Insurance amount

number format: double

contents_type

Contents type for customs

string

Merchandise

restriction_type

Restriction type for customs

string

none

country_of_origin

ISO 3166-1 alpha-2 country code

string

US

channel_items

Required for Amazon orders to enable protections

Array<object>

object

remote_id

required

Amazon line item ID or unique item identifier

string

148539107022961

quantity

Item quantity (required for Amazon protections, defaults to 1)

integer

default: 1 >= 1

value

Item value (required for Amazon protections, defaults to ‘1.0’)

string

default: 1.0

25.00

currency_code

ISO 4217 currency code (required for Amazon protections, defaults to request currency or company currency)

string

USD

asin

Amazon ASIN (required for international Amazon orders)

string

B08N5WRWNW

tariff_code

HS/tariff code for customs

string

8471.30.01

country_of_manufacture

ISO 3166-1 alpha-2 country code (defaults to normalized from_address country)

string

CN

description

Item description (defaults to contents param or ‘Merchandise’)

string

Laptop Computer

shipping_configuration_ids

Specific shipping configs to use (only 1 from each sub-carrier)

Array<string>

[
  "123"
]

include_unavailable_quotes

Include unavailable quotes in response

boolean

default: true

Examples

Domestic US shipment

{
  "to_address": {
    "name": "John Smith",
    "phone": "+12125551234",
    "line1": "350 5th Ave",
    "town": "New York",
    "postcode": "10118",
    "country_code": "US",
    "county": "NY"
  },
  "from_address": {
    "name": "Veeqo Fulfillment",
    "company": "Veeqo Inc",
    "phone": "+12065551234",
    "line1": "410 Terry Ave N",
    "town": "Seattle",
    "postcode": "98109",
    "country_code": "US",
    "county": "WA"
  },
  "parcels": [
    {
      "weight": 1.5,
      "weight_unit": "lb",
      "height": 10,
      "width": 10,
      "length": 10,
      "dimension_unit": "in"
    }
  ],
  "customer_reference": "ORDER-12345"
}

Amazon order with Buy Shipping protections

{
  "to_address": {
    "name": "Sarah Johnson",
    "phone": "+13125551234",
    "line1": "233 S Wacker Dr",
    "town": "Chicago",
    "postcode": "60606",
    "country_code": "US",
    "county": "IL"
  },
  "from_address": {
    "name": "Veeqo Fulfillment",
    "company": "Veeqo Inc",
    "phone": "+12065551234",
    "line1": "410 Terry Ave N",
    "town": "Seattle",
    "postcode": "98109",
    "country_code": "US",
    "county": "WA"
  },
  "parcels": [
    {
      "weight": 2,
      "weight_unit": "lb",
      "height": 8,
      "width": 8,
      "length": 8,
      "dimension_unit": "in"
    }
  ],
  "customer_reference": "112-4737182-6879466",
  "is_amazon_order": true,
  "estimated_value": "25.00",
  "currency_code": "USD",
  "seller_display_name": "My Store Name",
  "channel_items": [
    {
      "remote_id": "148539107022961",
      "quantity": 1,
      "value": "25.00",
      "currency_code": "USD"
    }
  ]
}

International Amazon order with ASIN

{
  "to_address": {
    "name": "Marie Leclerc",
    "phone": "+33140205050",
    "line1": "Champ de Mars",
    "line2": "5 Avenue Anatole France",
    "town": "Paris",
    "postcode": "75007",
    "country_code": "FR"
  },
  "from_address": {
    "name": "Veeqo Fulfillment",
    "company": "Veeqo Inc",
    "phone": "+12065551234",
    "line1": "410 Terry Ave N",
    "town": "Seattle",
    "postcode": "98109",
    "country_code": "US",
    "county": "WA"
  },
  "parcels": [
    {
      "weight": 1,
      "weight_unit": "lb",
      "height": 6,
      "width": 6,
      "length": 6,
      "dimension_unit": "in"
    }
  ],
  "customer_reference": "405-1234567-8901234",
  "is_amazon_order": true,
  "estimated_value": "50.00",
  "currency_code": "EUR",
  "seller_display_name": "My Store Name",
  "contents": "Electronics",
  "channel_items": [
    {
      "remote_id": "148539107022961",
      "asin": "B08N5WRWNW",
      "quantity": 1,
      "value": "50.00",
      "currency_code": "EUR",
      "tariff_code": "8471.30.01",
      "country_of_manufacture": "CN",
      "description": "Laptop Computer"
    }
  ]
}

Using saved address IDs

{
  "to_address": {
    "address_id": "78722344-3738-48f7-857e-e6dff79db84e"
  },
  "from_address": {
    "address_id": "b8b3e7b6-3adc-417f-963b-dd9851947ac2"
  },
  "parcels": [
    {
      "weight": 1.5,
      "weight_unit": "lb",
      "height": 10,
      "width": 10,
      "length": 10,
      "dimension_unit": "in"
    }
  ]
}

Responses

200

Successful response with shipping quotes

object

quotes

Array<object>

object

carrier

Carrier identifier

string

amazon_shipping_v2

carrier_nice_name

Human-readable carrier name

string

Amazon Shipping

title

Service name

string

USPS Ground Advantage (1 - 70 lb)

code

Unique quote identifier for booking

string

amazon_shipping_v2-df3f52c6-643e-4959-b802-f60ca1df42bb

total_net_charge

Total cost

string

10.50

currency_code

Currency code

string

USD

delivery_date

Estimated delivery date

string format: date-time

nullable

own_account

Whether using a linked account

boolean

protected

Whether the rate includes Buy Shipping protections

boolean

protections

Types of protections included

Array<string>

[
  "CLAIMS_PROTECTED"
]

charges

Array<object>

object

price

Formatted price with currency symbol

string

$52.50

charge_id

Unique identifier for the charge type

string

BASE_SHIPPING

charge_title

Human-readable charge description

string

Base Shipping Cost

charge_type

Charge type

string

Allowed values: MANDATORY OPTIONAL

shipping_service_options

Array<object>

object

key

Parameter name for booking request

string

value_added_service__VAS_GROUP_ID_CONFIRMATION

title

Human-readable title

string

Signature Confirmation

type

Input type

string

Allowed values: select number text

values

Available values for select type

Array<object>

object

value

string

label

string

validation

Validation rules for number type

object

min

number

max

number

default

Default value

string

nullable

unavailable_quotes

Quotes that are not available (when include_unavailable_quotes=true)

Array<object>

object

carrier

Carrier identifier

string

amazon_shipping_v2

name

Service name

string

AMZ-4PX Global Express Priority-Li

service_carrier

Sub-carrier name

string

nullable

4PX

sub_carrier_id

Sub-carrier identifier

string

4PX

unavailable_reasons

Reasons why this service is not available

Array<object>

object

message

Reason why the service is unavailable

string

Not an eligible ship method for this order. Please check carrier's requirements for this ship method.

remote_shipment_id

Unique shipment identifier

string

prb8a99eb17

request_token

Token for booking the shipment

string

token-abc-123

expires_at

When the quotes expire

string format: date-time

2025-10-02T15:54:49Z

to_address_id

Resolved to_address ID

string

nullable

from_address_id

Resolved from_address ID

string

nullable

Examples

Response with available quotes only

{
  "quotes": [
    {
      "rate_id": "amazon_shipping_v2-8990db9c-931e-4287-a8b7-6659dbfac82a",
      "service_name": "UPS Ground Saver",
      "carrier_id": "UPS",
      "service_carrier": "ups",
      "currency": "USD",
      "delivery_estimate": "2025-12-14T07:59:59+00:00",
      "pickup_window": {
        "end": null,
        "start": null
      },
      "charges": [
        {
          "price": "6.16",
          "charge_id": "BASE_RATE",
          "charge_title": "Base Rate",
          "charge_type": "MANDATORY"
        }
      ],
      "total_charge": "6.16",
      "base_rate": "6.16",
      "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"
            }
          ]
        }
      ],
      "credits": 0.308,
      "own_account": false,
      "protected": true,
      "protections": [
        "CLAIMS_PROTECTED"
      ],
      "service_id": "UPS_PTP_GROUNDSAVER"
    },
    {
      "rate_id": "amazon_shipping_v2-4ce028f4-681d-4e4f-a905-91f1e493a012",
      "service_name": "USPS Ground Advantage (1 - 70 lb)",
      "carrier_id": "USPS",
      "service_carrier": "usps",
      "currency": "USD",
      "delivery_estimate": "2025-12-16T07:59:59+00:00",
      "pickup_window": {
        "end": null,
        "start": null
      },
      "charges": [
        {
          "price": "6.41",
          "charge_id": "BASE_RATE",
          "charge_title": "Base Rate",
          "charge_type": "MANDATORY"
        },
        {
          "price": "3.95",
          "charge_id": "SIGNATURE_CONFIRMATION",
          "charge_title": "Signature confirmation",
          "charge_type": "OPTIONAL"
        }
      ],
      "total_charge": "6.41",
      "base_rate": "6.41",
      "shipping_service_options": [
        {
          "key": "value_added_service__VAS_GROUP_ID_CONFIRMATION",
          "label": "Confirmation",
          "type": "select",
          "multiple": false,
          "values": [
            {
              "value": "DELIVERY_CONFIRMATION",
              "label": "Delivery confirmation",
              "price": 0,
              "currency": "USD"
            },
            {
              "value": "SIGNATURE_CONFIRMATION",
              "label": "Signature confirmation",
              "price": 3.95,
              "currency": "USD"
            }
          ]
        },
        {
          "key": "liability_amount",
          "label": "Insurance",
          "type": "number",
          "multiple": false
        }
      ],
      "credits": 0.3205,
      "own_account": false,
      "protected": true,
      "protections": [
        "CLAIMS_PROTECTED"
      ],
      "service_id": "USPS_PTP_GAH"
    }
  ],
  "remote_shipment_id": "prba10f56ed",
  "request_token": "amzn1.rq.3d43e540-e6b7-4b57-bb3d-b7582fcbbea1.101",
  "expires_at": "2025-12-11T18:29:18.234Z",
  "to_address_id": "78722344-3738-48f7-857e-e6dff79db84e",
  "from_address_id": "b8b3e7b6-3adc-417f-963b-dd9851947ac2"
}

Response including unavailable quotes

{
  "quotes": [
    {
      "rate_id": "amazon_shipping_v2-74366f06-be30-41f4-87e4-8c45492420ba",
      "service_name": "UPS Ground Saver",
      "carrier_id": "UPS",
      "service_carrier": "ups",
      "currency": "USD",
      "delivery_estimate": "2025-12-14T07:59:59+00:00",
      "total_charge": "6.16",
      "base_rate": "6.16",
      "credits": 0.308,
      "own_account": false,
      "protected": true,
      "protections": [
        "CLAIMS_PROTECTED"
      ],
      "service_id": "UPS_PTP_GROUNDSAVER"
    },
    {
      "rate_id": "amazon_shipping_v2-55e8a9fe-4be1-47bb-87fc-e43dc467d50a",
      "service_name": "USPS Ground Advantage (1 - 70 lb)",
      "carrier_id": "USPS",
      "service_carrier": "usps",
      "currency": "USD",
      "delivery_estimate": "2025-12-16T07:59:59+00:00",
      "total_charge": "6.41",
      "base_rate": "6.41",
      "credits": 0.3205,
      "own_account": false,
      "protected": true,
      "protections": [
        "CLAIMS_PROTECTED"
      ],
      "service_id": "USPS_PTP_GAH"
    }
  ],
  "unavailable_quotes": [
    {
      "carrier": "amazon_shipping_v2",
      "name": "AMZ-4PX Global Express Priority-Li",
      "service_carrier": "4PX",
      "sub_carrier_id": "4PX",
      "unavailable_reasons": [
        {
          "message": "Not an eligible ship method for this order. Please check carrier's requirements for this ship method."
        }
      ]
    },
    {
      "carrier": "amazon_shipping_v2",
      "name": "USPS Media Mail",
      "service_carrier": "USPS",
      "sub_carrier_id": "USPS",
      "unavailable_reasons": [
        {
          "message": "The shipping service is not available for the products in the order."
        }
      ]
    },
    {
      "carrier": "amazon_shipping_v2",
      "name": "UPS Ground Saver (less than 1 lb)",
      "service_carrier": "UPS",
      "sub_carrier_id": "UPS",
      "unavailable_reasons": [
        {
          "message": "Package weight is exceeding the maximum supported weight.Package weight is 1.4999998346533032LB, max package weight is 0.9993748898377633LB."
        }
      ]
    }
  ],
  "remote_shipment_id": "prb15828664",
  "request_token": "amzn1.rq.ed7acd82-38d9-45b5-8be3-9793343bfcc2.101",
  "expires_at": "2025-12-11T18:31:19.145Z",
  "to_address_id": "78722344-3738-48f7-857e-e6dff79db84e",
  "from_address_id": "b8b3e7b6-3adc-417f-963b-dd9851947ac2"
}

400

Bad request - validation error

object

error_messages

required

List of error messages

Array<string>

[
  "to_address is required"
]

{
  "error_messages": [
    "Invalid request parameters"
  ]
}

403

Forbidden - feature not enabled

object

error_messages

required

List of error messages

Array<string>

[
  "to_address is required"
]

Example

{
  "error_messages": [
    "You do not have permission to access this feature."
  ]
}

422

Unprocessable entity - API error

object

error_messages

required

List of error messages

Array<string>

[
  "to_address is required"
]

{
  "error_messages": [
    "Invalid request parameters"
  ]
}

Get shipping rates

Request Body required

Examples

Responses

200

Examples

400

403

Example

422

Request Body^required