List Estimated Shipping Rates

curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/cart/estimate_shipping_rates \
  --header 'X-Spree-Order-Token: <api-key>'

{
  "data": [
    {
      "id": "1",
      "type": "shipping_rate",
      "attributes": {
        "name": "USPS Ground",
        "selected": true,
        "cost": "10.0",
        "tax_amount": "0.0",
        "shipping_method_id": 1,
        "final_price": "10.0",
        "display_cost": "$10.00",
        "display_final_price": "$10.00",
        "display_tax_amount": "$0.00",
        "free": true
      },
      "relationships": {
        "shipping_method": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        }
      }
    }
  ]
}

GET

api

storefront

cart

estimate_shipping_rates

List Estimated Shipping Rates

curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/cart/estimate_shipping_rates \
  --header 'X-Spree-Order-Token: <api-key>'

{
  "data": [
    {
      "id": "1",
      "type": "shipping_rate",
      "attributes": {
        "name": "USPS Ground",
        "selected": true,
        "cost": "10.0",
        "tax_amount": "0.0",
        "shipping_method_id": 1,
        "final_price": "10.0",
        "display_cost": "$10.00",
        "display_final_price": "$10.00",
        "display_tax_amount": "$0.00",
        "free": true
      },
      "relationships": {
        "shipping_method": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        }
      }
    }
  ]
}

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.

Example:

"USA"

fields[shipping_rate]

string

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

Response

200 Success - Returns an array of shipping_rate objects.

data

Shipping Rate · object[]

required

Show child attributes

data.id

string | null

required

Example:

"1"

data.type

string

default:shipping_rate

required

data.attributes

object

required

Show child attributes

data.attributes.name

string

Example:

"USPS Ground"

data.attributes.selected

boolean

Example:

true

data.attributes.cost

string

Price of the service without discounts applied

Example:

"10.0"

data.attributes.tax_amount

string

Eligible tax for service (if any)

Example:

"0.0"

data.attributes.shipping_method_id

integer

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

Example:

1

data.attributes.final_price

string

Price to be presented for the Customer

Example:

"10.0"

data.attributes.display_cost

string

Example:

"$10.00"

data.attributes.display_final_price

string

Example:

"$10.00"

data.attributes.display_tax_amount

string

Example:

"$0.00"

data.attributes.free

boolean

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

Example:

true

data.relationships

object

required

Show child attributes

data.relationships.shipping_method

object

Shipping method for which this shipping rate belongs to

Show child attributes

data.relationships.shipping_method.data

object

Show child attributes

data.relationships.shipping_method.data.id

string

required

data.relationships.shipping_method.data.type

string

required

Empty the Cart

Associate a Cart with a User

⌘I

API basics

Tutorials

Storefront API

Platform API

List Estimated Shipping Rates

Authorizations

Query Parameters

Response