List Estimated Shipping Rates

Returns a list of shipping rates for the current cart. The rates given are only estimates and can vary from the final shipping rates.

Authorizations

X-Spree-Order-Token

string

header

required

Order token to authorize Cart and Checkout requests.

How to obtain X-Spree-Order-Token

Query Parameters

country_iso

string

required

Pass country ISO or ISO3 symbol to get estimations for this destination. If no code is passed we'll try to use Cart shipping address country or the default Country for the current Store.

fields[shipping_rate]

string

Specify the fields you would like returned in the response body. More information.

Response

200

application/vnd.api+json

200 Success - Returns an array of `shipping_rate` objects.

data

object[]

required

Show child attributes

data.id

string | null

required

data.type

string

default:

shipping_rate

required

data.attributes

object

required

Show child attributes

data.attributes.name

string

data.attributes.selected

boolean

data.attributes.cost

string

Price of the service without discounts applied

data.attributes.tax_amount

string

Eligible tax for service (if any)

data.attributes.shipping_method_id

integer

ID of a Shipping Method. You will need this for the Checkout Update action

data.attributes.final_price

string

Price to be presented for the Customer

data.attributes.display_cost

string

data.attributes.display_final_price

string

data.attributes.display_tax_amount

string

data.attributes.free

boolean

Indicates if the Shipping Rate is free, eg. when Free shipping promo applied to Cart