Selects shipping method for shipment(s) - Spree Commerce documentation

Community

Github

API basics

Storefront API

Authentication
Account
Account / Address
Account / Credit Cards
Account / Orders
Order Status
Cart
Cart / Line Items
Cart / Other
Cart / Coupons
Checkout
Checkout / State
Checkout / Shipments
- PATCH
  Selects shipping method for shipment(s)
- GET
  List Shipping Rates
Checkout / Payments
Checkout / Store Credit
Products
Stores
Taxons
Countries
CMS Pages
Menus
Wishlists
Wishlists / Wished Items
Digital Downloads

Platform API

Authentication
Addresses
Adjustments
Classifications
CMS Pages
CMS Sections
Countries
Data Feeds
Digital Links
Digital Assets
Line Items
Menu Items
Menus
Option Types
Option Values
Orders
Payment Methods
Payments
Products
Promotion Actions
Promotion Categories
Promotion Rules
Promotions
Roles
Shipments
Shipping Categories
Shipping Methods
States
Stock Items
Stock Locations
Store Credit Categories
Store Credit Types
Store Credits
Tax Categories
Tax Rates
Taxonomies
Taxons
Users
Variants
Webhook Events
Webhook Subscribers
Wished Items
Wishlists
Zones

PATCH

api

storefront

checkout

select_shipping_method

curl --request PATCH \
  --url https://demo.spreecommerce.org/api/v2/storefront/checkout/select_shipping_method \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Spree-Order-Token: <api-key>' \
  --data '{
  "shipping_method_id": "1"
}'

{
  "data": {
    "id": "17",
    "type": "cart",
    "attributes": {
      "number": "R233871560",
      "item_total": "0.0",
      "total": "0.0",
      "ship_total": "0.0",
      "adjustment_total": "0.0",
      "created_at": "2021-09-28T22:15:07.471Z",
      "updated_at": "2021-09-28T22:15:07.471Z",
      "completed_at": null,
      "included_tax_total": "0.0",
      "additional_tax_total": "0.0",
      "display_additional_tax_total": "$0.00",
      "display_included_tax_total": "$0.00",
      "tax_total": "0.0",
      "currency": "USD",
      "state": "cart",
      "token": "zTEpsukRq_yEUcXVCSv0uw1632867307450",
      "email": null,
      "display_item_total": "$0.00",
      "display_ship_total": "$0.00",
      "display_adjustment_total": "$0.00",
      "display_tax_total": "$0.00",
      "promo_total": "0.0",
      "display_promo_total": "$0.00",
      "item_count": 0,
      "special_instructions": null,
      "display_total": "$0.00",
      "pre_tax_item_amount": "0.0",
      "display_pre_tax_item_amount": "$0.00",
      "pre_tax_total": "0.0",
      "display_pre_tax_total": "$0.00",
      "shipment_state": null,
      "payment_state": null
    },
    "relationships": {
      "line_items": {
        "data": []
      },
      "variants": {
        "data": []
      },
      "promotions": {
        "data": []
      },
      "payments": {
        "data": []
      },
      "shipments": {
        "data": []
      },
      "user": {
        "data": null
      },
      "billing_address": {
        "data": null
      },
      "shipping_address": {
        "data": null
      }
    }
  }
}

Authorizations

X-Spree-Order-Token

string

headerrequired

Order token to authorize Cart and Checkout requests.

How to obtain X-Spree-Order-Token

Query Parameters

include

string

Specify the related resources you would like to receive in the response body. More Information.

fields[cart]

string

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

Body

application/vnd.api+json

shipping_method_id

string

required

ID of the selected Shipping Method

shipment_id

string

ID of the selected Shipment. If not supplied it will try to set selected shipping method for all shipments

Response

200 - application/vnd.api+json

data

object

required

The Cart provides a central place to collect information about an order, including line items, adjustments, payments, addresses, and shipments. Read more in Spree docs

data.id

string

required

data.type

string

default: cartrequired

data.attributes

object

required

data.attributes.number

string

Used as the {order_number} value in the URI to identify a completed order.

data.attributes.token

string

Used for authorizing actions through the X-Spree-Order-Token API Key.

data.attributes.item_total

string

data.attributes.total

string

data.attributes.ship_total

string

data.attributes.adjustment_total

string

data.attributes.created_at

string

data.attributes.updated_at

string

data.attributes.completed_at

string | null

data.attributes.included_tax_total

string

data.attributes.additional_tax_total

string

data.attributes.display_additional_tax_total

string

data.attributes.tax_total

string

data.attributes.currency

string

data.attributes.state

enum<string>

State of the Cart in the Checkout flow. Please see <a href="/developer/core-concepts/orders#the-order-state-machine"> The Order State machine </a> for a full list with description.

Available options:

cart,

address,

delivery,

payment,

confirm,

complete

data.attributes.email

string | null

data.attributes.display_item_total

string

data.attributes.display_ship_total

string

data.attributes.display_adjustment_total

string

data.attributes.display_included_tax_total

string

data.attributes.item_count

number

Total quantity number of all items added to the Cart

Required range: x > 0

data.attributes.special_instructions

string | null

Message added by the Customer

data.attributes.display_total

string

data.attributes.pre_tax_item_amount

string

data.attributes.display_pre_tax_item_amount

string

data.attributes.pre_tax_total

string

data.attributes.display_tax_total

string

data.attributes.display_pre_tax_total

string

data.attributes.shipment_state

enum<string> | null

Overall state of the Shipments. Please see <a href="/developer/core-concepts/orders#order-shipment-states-1"> Order Shipments states </a> for a full list with description.

Available options:

pending,

backorder,

canceled,

partial,

ready,

shipped

data.attributes.payment_state

enum<string> | null

Overall state of the Payments. Please see <a href="/developer/core-concepts/orders#order-payment-states"> Order Payments states </a> for a full list with description.

Available options:

balance_due,

credit_owed,

failed,

paid,

void

data.relationships

object

required

included

object[]

Was this page helpful?

Complete Checkout List Shipping Rates

curl --request PATCH \
  --url https://demo.spreecommerce.org/api/v2/storefront/checkout/select_shipping_method \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Spree-Order-Token: <api-key>' \
  --data '{
  "shipping_method_id": "1"
}'

{
  "data": {
    "id": "17",
    "type": "cart",
    "attributes": {
      "number": "R233871560",
      "item_total": "0.0",
      "total": "0.0",
      "ship_total": "0.0",
      "adjustment_total": "0.0",
      "created_at": "2021-09-28T22:15:07.471Z",
      "updated_at": "2021-09-28T22:15:07.471Z",
      "completed_at": null,
      "included_tax_total": "0.0",
      "additional_tax_total": "0.0",
      "display_additional_tax_total": "$0.00",
      "display_included_tax_total": "$0.00",
      "tax_total": "0.0",
      "currency": "USD",
      "state": "cart",
      "token": "zTEpsukRq_yEUcXVCSv0uw1632867307450",
      "email": null,
      "display_item_total": "$0.00",
      "display_ship_total": "$0.00",
      "display_adjustment_total": "$0.00",
      "display_tax_total": "$0.00",
      "promo_total": "0.0",
      "display_promo_total": "$0.00",
      "item_count": 0,
      "special_instructions": null,
      "display_total": "$0.00",
      "pre_tax_item_amount": "0.0",
      "display_pre_tax_item_amount": "$0.00",
      "pre_tax_total": "0.0",
      "display_pre_tax_total": "$0.00",
      "shipment_state": null,
      "payment_state": null
    },
    "relationships": {
      "line_items": {
        "data": []
      },
      "variants": {
        "data": []
      },
      "promotions": {
        "data": []
      },
      "payments": {
        "data": []
      },
      "shipments": {
        "data": []
      },
      "user": {
        "data": null
      },
      "billing_address": {
        "data": null
      },
      "shipping_address": {
        "data": null
      }
    }
  }
}