Selects a shipping rate for the shipment
JavaScript
import { createSpreeClient } from '@spree/sdk' const client = createSpreeClient({ baseUrl: 'https://your-store.com', publishableKey: '<api-key>', }) const order = await client.store.orders.shipments.update('or_abc123', 'shp_abc123', { selected_shipping_rate_id: 'shprt_abc123', }, { bearerToken: '<token>', })
{ "id": "or_UkLWZg9DAJ", "number": "R484741240", "state": "delivery", "checkout_steps": [ "address", "delivery", "payment", "complete" ], "token": "PhecHPaty6dXnmwezmpk698qhY1JXW4HZ8n", "email": "shira_mccullough@schusterbailey.ca", "special_instructions": null, "currency": "USD", "locale": "en", "item_count": 1, "state_lock_version": 1, "shipment_state": null, "payment_state": null, "item_total": "10.0", "display_item_total": "$10.00", "ship_total": "100.0", "display_ship_total": "$100.00", "adjustment_total": "0.0", "display_adjustment_total": "$0.00", "promo_total": "0.0", "display_promo_total": "$0.00", "tax_total": "0.0", "display_tax_total": "$0.00", "included_tax_total": "0.0", "display_included_tax_total": "$0.00", "additional_tax_total": "0.0", "display_additional_tax_total": "$0.00", "total": "110.0", "display_total": "$110.00", "completed_at": null, "created_at": "2026-03-05T20:52:42.608Z", "updated_at": "2026-03-05T20:52:42.752Z", "order_promotions": [], "line_items": [ { "id": "li_UkLWZg9DAJ", "variant_id": "variant_UkLWZg9DAJ", "quantity": 1, "currency": "USD", "name": "Product 1077255", "slug": "product-1077255", "options_text": "", "price": "10.0", "display_price": "$10.00", "total": "10.0", "display_total": "$10.00", "adjustment_total": "0.0", "display_adjustment_total": "$0.00", "additional_tax_total": "0.0", "display_additional_tax_total": "$0.00", "included_tax_total": "0.0", "display_included_tax_total": "$0.00", "promo_total": "0.0", "display_promo_total": "$0.00", "pre_tax_amount": "10.0", "display_pre_tax_amount": "$10.00", "discounted_amount": "10.0", "display_discounted_amount": "$10.00", "display_compare_at_amount": "$0.00", "created_at": "2026-03-05T20:52:42.654Z", "updated_at": "2026-03-05T20:52:42.654Z", "compare_at_amount": null, "thumbnail_url": null, "option_values": [], "digital_links": [] } ], "shipments": [ { "id": "ship_UkLWZg9DAJ", "number": "H37316972105", "state": "pending", "tracking": "U10000", "tracking_url": null, "cost": "100.0", "display_cost": "$100.00", "shipped_at": null, "created_at": "2026-03-05T20:52:42.668Z", "updated_at": "2026-03-05T20:52:42.750Z", "shipping_method": { "id": "shpm_UkLWZg9DAJ", "name": "UPS Ground", "code": "UPS_GROUND" }, "stock_location": { "id": "sloc_UkLWZg9DAJ", "state_abbr": "STATE_ABBR_306", "name": "Courtney Moen", "address1": "1600 Pennsylvania Ave NW", "city": "Washington", "zipcode": "20500", "country_iso": "US", "country_name": "United States of America", "state_text": "STATE_ABBR_306" }, "shipping_rates": [ { "id": "shpr_UkLWZg9DAJ", "shipping_method_id": "shpm_UkLWZg9DAJ", "name": "UPS Ground", "selected": true, "cost": "100.0", "display_cost": "$100.00", "shipping_method": { "id": "shpm_UkLWZg9DAJ", "name": "UPS Ground", "code": "UPS_GROUND" } } ] } ], "payments": [], "bill_address": { "id": "addr_EfhxLZ9ck8", "firstname": "John", "lastname": "Doe", "full_name": "John Doe", "address1": "298 Lovely Street", "address2": "Northwest", "city": "Herndon", "zipcode": "35005", "phone": "555-555-0199", "company": "Company", "country_name": "United States of America", "country_iso": "US", "state_text": "STATE_ABBR_308", "state_abbr": "STATE_ABBR_308", "quick_checkout": false, "state_name": "STATE_NAME_308" }, "ship_address": { "id": "addr_VqXmZF31wY", "firstname": "John", "lastname": "Doe", "full_name": "John Doe", "address1": "299 Lovely Street", "address2": "Northwest", "city": "Herndon", "zipcode": "35005", "phone": "555-555-0199", "company": "Company", "country_name": "United States of America", "country_iso": "US", "state_text": "STATE_ABBR_309", "state_abbr": "STATE_ABBR_309", "quick_checkout": false, "state_name": "STATE_NAME_309" }, "payment_methods": [] }
Publishable API key for store access
JWT token for authenticated customers
Order token for guest access
Shipment ID
Shipping rate ID to select
"shprt_abc123"
shipping rate selected, returns updated order
Show child attributes
Was this page helpful?