Returns a list of available shipping rates for the checkout.
Shipping rates are grouped against shipments. Each checkout can have multiple shipments. Some products are in stock and will be shipped immediately, while others might be back-ordered and sent later.
const options = {method: 'GET', headers: {'X-Spree-Order-Token': '<api-key>'}};
fetch('https://demo.spreecommerce.org/api/v2/storefront/checkout/shipping_rates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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"
}
}
]
}Order token to authorize Cart and Checkout requests.
Was this page helpful?
const options = {method: 'GET', headers: {'X-Spree-Order-Token': '<api-key>'}};
fetch('https://demo.spreecommerce.org/api/v2/storefront/checkout/shipping_rates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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"
}
}
]
}