List Shipping Rates

List Shipping Rates

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

{
  "data": [
    {
      "id": "3",
      "type": "shipment",
      "attributes": {
        "number": "H97593072360",
        "final_price": "5.0",
        "display_final_price": "$5.00",
        "state": "pending",
        "shipped_at": null,
        "tracking_url": null,
        "free": false
      },
      "relationships": {
        "shipping_rates": {
          "data": [
            {
              "id": "10",
              "type": "shipping_rate"
            },
            {
              "id": "11",
              "type": "shipping_rate"
            },
            {
              "id": "12",
              "type": "shipping_rate"
            }
          ]
        },
        "stock_location": {
          "data": {
            "id": "1",
            "type": "stock_location"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "10",
      "type": "shipping_rate",
      "attributes": {
        "name": "UPS Ground (USD)",
        "selected": true,
        "final_price": "5.0",
        "display_final_price": "$5.00",
        "cost": "5.0",
        "display_cost": "$5.00",
        "tax_amount": "0.0",
        "display_tax_amount": "$0.00",
        "shipping_method_id": "1",
        "free": false
      },
      "relationships": {
        "shipping_method": {
          "data": {
            "id": "1",
            "type": "shipping_method"
          }
        }
      }
    },
    {
      "id": "11",
      "type": "shipping_rate",
      "attributes": {
        "name": "UPS Two Day (USD)",
        "selected": false,
        "final_price": "10.0",
        "display_final_price": "$10.00",
        "cost": "10.0",
        "display_cost": "$10.00",
        "tax_amount": "0.0",
        "display_tax_amount": "$0.00",
        "shipping_method_id": "2",
        "free": false
      },
      "relationships": {
        "shipping_method": {
          "data": {
            "id": "2",
            "type": "shipping_method"
          }
        }
      }
    },
    {
      "id": "12",
      "type": "shipping_rate",
      "attributes": {
        "name": "UPS One Day (USD)",
        "selected": false,
        "final_price": "15.0",
        "display_final_price": "$15.00",
        "cost": "15.0",
        "display_cost": "$15.00",
        "tax_amount": "0.0",
        "display_tax_amount": "$0.00",
        "shipping_method_id": "3",
        "free": false
      },
      "relationships": {
        "shipping_method": {
          "data": {
            "id": "3",
            "type": "shipping_method"
          }
        }
      }
    },
    {
      "id": "1",
      "type": "stock_location",
      "attributes": {
        "name": "default"
      }
    }
  ]
}

GET

api

storefront

checkout

shipping_rates

List Shipping Rates

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

{
  "data": [
    {
      "id": "3",
      "type": "shipment",
      "attributes": {
        "number": "H97593072360",
        "final_price": "5.0",
        "display_final_price": "$5.00",
        "state": "pending",
        "shipped_at": null,
        "tracking_url": null,
        "free": false
      },
      "relationships": {
        "shipping_rates": {
          "data": [
            {
              "id": "10",
              "type": "shipping_rate"
            },
            {
              "id": "11",
              "type": "shipping_rate"
            },
            {
              "id": "12",
              "type": "shipping_rate"
            }
          ]
        },
        "stock_location": {
          "data": {
            "id": "1",
            "type": "stock_location"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "10",
      "type": "shipping_rate",
      "attributes": {
        "name": "UPS Ground (USD)",
        "selected": true,
        "final_price": "5.0",
        "display_final_price": "$5.00",
        "cost": "5.0",
        "display_cost": "$5.00",
        "tax_amount": "0.0",
        "display_tax_amount": "$0.00",
        "shipping_method_id": "1",
        "free": false
      },
      "relationships": {
        "shipping_method": {
          "data": {
            "id": "1",
            "type": "shipping_method"
          }
        }
      }
    },
    {
      "id": "11",
      "type": "shipping_rate",
      "attributes": {
        "name": "UPS Two Day (USD)",
        "selected": false,
        "final_price": "10.0",
        "display_final_price": "$10.00",
        "cost": "10.0",
        "display_cost": "$10.00",
        "tax_amount": "0.0",
        "display_tax_amount": "$0.00",
        "shipping_method_id": "2",
        "free": false
      },
      "relationships": {
        "shipping_method": {
          "data": {
            "id": "2",
            "type": "shipping_method"
          }
        }
      }
    },
    {
      "id": "12",
      "type": "shipping_rate",
      "attributes": {
        "name": "UPS One Day (USD)",
        "selected": false,
        "final_price": "15.0",
        "display_final_price": "$15.00",
        "cost": "15.0",
        "display_cost": "$15.00",
        "tax_amount": "0.0",
        "display_tax_amount": "$0.00",
        "shipping_method_id": "3",
        "free": false
      },
      "relationships": {
        "shipping_method": {
          "data": {
            "id": "3",
            "type": "shipping_method"
          }
        }
      }
    },
    {
      "id": "1",
      "type": "stock_location",
      "attributes": {
        "name": "default"
      }
    }
  ]
}

Authorizations

X-Spree-Order-Token

string

header

required

Order token to authorize Cart and Checkout requests.

How to obtain X-Spree-Order-Token

Response

200 Success - Returns an array containing several shipment objects, along with the included array containing all available shipping_rate and stock_location objects.

data

Shipment · object[]

required

Show child attributes

data.id

string

required

Example:

"1"

data.type

string

default:shipment

required

data.attributes

object

required

Show child attributes

data.attributes.number

string

Unique Shipment identifier

Example:

"H121354"

data.attributes.free

boolean

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

data.attributes.final_price

string

Price to be presented for the Customer

Example:

"10.0"

data.attributes.display_final_price

string

Example:

"$10.00"

data.attributes.tracking_url

string | null

Tracking URL to the service provider website

Example:

"https://tools.usps.com/go/TrackConfirmAction?tRef=fullpage&tLc=2&text28777=&tLabels=4123412434%2C"

data.attributes.state

enum<string>

Status of the Shipment. For a list of all available statuses please refer: Shipment section in Spree Guides

Available options:

pending,

ready,

shipped,

canceled

Example:

"shipped"

data.attributes.shipped_at

string<date-time> | null

Date when Shipment was being sent from the warehouse

Example:

"2021-01-02 13:42:12"

data.relationships

object

required

Show child attributes

data.relationships.stock_location

object

Show child attributes

data.relationships.stock_location.data

object

Show child attributes

data.relationships.stock_location.data.id

string

required

data.relationships.stock_location.data.type

string

required

data.relationships.shipping_rates

object

Show child attributes

data.relationships.shipping_rates.data

(object | null)[]

Show child attributes

data.relationships.shipping_rates.data.id

string

required

data.relationships.shipping_rates.data.type

string

required

included

Shipment Includes · object[]

required

Show child attributes

included.id

string

required

Example:

"1"

included.type

string

default:stock_location

required

included.attributes

object

required

Show child attributes

included.attributes.name

string

Example:

"Main Warehouse"

included.attributes.selected

boolean

Example:

true

included.attributes.cost

string

Price of the service without discounts applied

Example:

"10.0"

included.attributes.tax_amount

string

Eligible tax for service (if any)

Example:

"0.0"

included.attributes.shipping_method_id

integer

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

Example:

1

included.attributes.final_price

string

Price to be presented for the Customer

Example:

"10.0"

included.attributes.display_cost

string

Example:

"$10.00"

included.attributes.display_final_price

string

Example:

"$10.00"

included.attributes.display_tax_amount

string

Example:

"$0.00"

included.attributes.free

boolean

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

Example:

true

included.relationships

object

required

Show child attributes

included.relationships.shipping_method

object

Shipping method for which this shipping rate belongs to

Show child attributes

included.relationships.shipping_method.data

object

Show child attributes

included.relationships.shipping_method.data.id

string

required

included.relationships.shipping_method.data.type

string

required

Selects shipping method for shipment(s)

Create new Payment

⌘I

API basics

Tutorials

Storefront API

Platform API

Authorizations

Response