RateShopping / Get Shipping Rates

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.

POST

Query

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Body

Arguments

string

Amazon line item ID or unique item identifier

objectrequired

number

objectrequired

string

number

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

string

number

arrayrequired

string

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

string

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

string

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

number

string

Package contents description

string

number

string

Shipment value for insurance/customs

boolean

Hazardous materials indicator

string

ISO 4217 currency code

string

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

string

HS/tariff code for customs

string

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

boolean

Set to true for Amazon orders to enable protections

string

Amazon ASIN (required for international Amazon orders)

string

Your store/seller name to display on shipping labels

string

boolean

string

ISO 8601 datetime

string

ISO 8601 datetime

number

Insurance amount

string

Contents type for customs

string

Restriction type for customs

string

ISO 3166-1 alpha-2 country code

array

string

array

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

boolean

Include unavailable quotes in response

Query

Body

Every app you connect,one REST pattern