Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Bridge/unify Store API with upcoming Spree 6 changes (#13782)

Damian Legawiece456d35efef8
diff --git a/docs/api-reference/store.yaml b/docs/api-reference/store.yaml
index fac9919efe..04b7581b9c 100644
--- a/docs/api-reference/store.yaml
+++ b/docs/api-reference/store.yaml
@@ -661,16 +661,16 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjI5MzJlYmY3LWNiNmUtNDdkNC1iYzc5LTI3YTU3YTJmYzYzNSIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczNjY0OTIzfQ.t5s-bHZ_RPSxJW3g-6Q-oryr8wKsy_gUllizQIwryS4
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjQ3ZDAzMDY5LWQ5MDgtNGM1ZS1hMDRiLTNkMmEzMDY1MmM4NCIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczNjk4NzM4fQ.uckU0mTRPZKFDzLAMK--5MJX68dmTf0BHUpLTK5YhDw
user:
id: cus_UkLWZg9DAJ
- first_name: Na
- last_name: Bailey
+ first_name: Bertie
+ last_name: Daniel
phone:
accepts_email_marketing: false
- created_at: '2026-03-16T11:42:03.325Z'
- updated_at: '2026-03-16T11:42:03.325Z'
+ created_at: '2026-03-16T21:05:38.664Z'
+ updated_at: '2026-03-16T21:05:38.664Z'
addresses: []
default_billing_address:
default_shipping_address:
@@ -747,16 +747,16 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjY4ZjdkMmMwLWU1ZjEtNDBmZi1hMDg0LTBiMjA0Y2I2ZDAwMiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczNjY0OTI0fQ.XQ0KorF8kID65mTA4wnxHtrQtoKU5P0SgKZfXx_utZw
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjJjMmVkNmFkLTAzMDItNGI1OC1hODVlLTc0ZWRkY2U5ODQxNiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczNjk4NzQwfQ.Zi34IfxwSb51rxERQR0H68LXO1pxyU18l2D_YdM9NRA
user:
id: cus_UkLWZg9DAJ
- first_name: Shiloh
- last_name: Kutch
+ first_name: Celeste
+ last_name: Weber
phone:
accepts_email_marketing: false
- created_at: '2026-03-16T11:42:04.747Z'
- updated_at: '2026-03-16T11:42:04.747Z'
+ created_at: '2026-03-16T21:05:40.071Z'
+ updated_at: '2026-03-16T21:05:40.071Z'
addresses: []
default_billing_address:
default_shipping_address:
@@ -814,17 +814,15 @@ paths:
example:
data:
- id: cart_gbHJdmfrXB
- number: R592928780
- token: GEAm9PwN7XmzKQ7JNmxx2n12ihh1gTJBgbG
+ number: R664884804
+ token: 8onrFHEkRBiwhJSWnQE4CZgGSkdpfoUgHWJ
special_instructions:
currency: USD
locale: en
item_count: 1
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'
@@ -837,8 +835,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-16T11:42:05.467Z'
- updated_at: '2026-03-16T11:42:05.516Z'
+ created_at: '2026-03-16T21:05:40.777Z'
+ updated_at: '2026-03-16T21:05:40.821Z'
+ delivery_total: '100.0'
+ display_delivery_total: "$100.00"
current_step: address
completed_steps: []
requirements:
@@ -851,8 +851,8 @@ paths:
variant_id: variant_gbHJdmfrXB
quantity: 1
currency: USD
- name: Product 23018
- slug: product-23018
+ name: Product 21560
+ slug: product-21560
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -871,46 +871,47 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:05.497Z'
- updated_at: '2026-03-16T11:42:05.497Z'
+ created_at: '2026-03-16T21:05:40.803Z'
+ updated_at: '2026-03-16T21:05:40.803Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
- shipments:
- - id: ship_gbHJdmfrXB
- number: H54022746010
- state: pending
+ fulfillments:
+ - id: ful_gbHJdmfrXB
+ number: H58804947918
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- shipped_at:
- created_at: '2026-03-16T11:42:05.505Z'
- updated_at: '2026-03-16T11:42:05.514Z'
- shipping_method:
- id: shpm_gbHJdmfrXB
+ created_at: '2026-03-16T21:05:40.810Z'
+ updated_at: '2026-03-16T21:05:40.819Z'
+ status: pending
+ fulfillment_type: shipping
+ fulfilled_at:
+ delivery_method:
+ id: dm_gbHJdmfrXB
name: UPS Ground
code: UPS_GROUND
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_37
- name: Raye Franecki
+ name: Jeannie Okuneva
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
country_iso: US
country_name: United States of America
state_text: STATE_ABBR_37
- shipping_rates:
- - id: shpr_gbHJdmfrXB
- shipping_method_id: shpm_gbHJdmfrXB
+ delivery_rates:
+ - id: dr_gbHJdmfrXB
+ delivery_method_id: dm_gbHJdmfrXB
name: UPS Ground
selected: true
cost: '100.0'
display_cost: "$100.00"
- shipping_method:
- id: shpm_gbHJdmfrXB
+ delivery_method:
+ id: dm_gbHJdmfrXB
name: UPS Ground
code: UPS_GROUND
payments: []
@@ -950,17 +951,15 @@ paths:
state_name: STATE_NAME_42
payment_methods: []
- id: cart_UkLWZg9DAJ
- number: R472289234
- token: xwmD8eiHXxkGKntwxDEuERyn7Y1zn2eewCm
+ number: R244500637
+ token: cduM2jNSoVyxrvtqrxDCYCzZH8SaJRJrz3G
special_instructions:
currency: USD
locale: en
item_count: 1
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'
@@ -973,8 +972,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-16T11:42:05.317Z'
- updated_at: '2026-03-16T11:42:05.460Z'
+ created_at: '2026-03-16T21:05:40.636Z'
+ updated_at: '2026-03-16T21:05:40.771Z'
+ delivery_total: '100.0'
+ display_delivery_total: "$100.00"
current_step: address
completed_steps: []
requirements:
@@ -987,8 +988,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 14966
- slug: product-14966
+ name: Product 15390
+ slug: product-15390
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1007,46 +1008,47 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:05.387Z'
- updated_at: '2026-03-16T11:42:05.387Z'
+ created_at: '2026-03-16T21:05:40.702Z'
+ updated_at: '2026-03-16T21:05:40.702Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
- shipments:
- - id: ship_UkLWZg9DAJ
- number: H63711482146
- state: pending
+ fulfillments:
+ - id: ful_UkLWZg9DAJ
+ number: H80152822677
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- shipped_at:
- created_at: '2026-03-16T11:42:05.400Z'
- updated_at: '2026-03-16T11:42:05.456Z'
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ created_at: '2026-03-16T21:05:40.714Z'
+ updated_at: '2026-03-16T21:05:40.767Z'
+ status: pending
+ fulfillment_type: shipping
+ fulfilled_at:
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_37
- name: Raye Franecki
+ name: Jeannie Okuneva
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
country_iso: US
country_name: United States of America
state_text: STATE_ABBR_37
- shipping_rates:
- - id: shpr_UkLWZg9DAJ
- shipping_method_id: shpm_UkLWZg9DAJ
+ delivery_rates:
+ - id: dr_UkLWZg9DAJ
+ delivery_method_id: dm_UkLWZg9DAJ
name: UPS Ground
selected: true
cost: '100.0'
display_cost: "$100.00"
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
payments: []
@@ -1159,8 +1161,8 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R295996236
- token: NzSJZ3FryrE1GrCtYiQhpqkKGzr2xq8RBsd
+ number: R962113929
+ token: ZGFjAxXRixXPGsQZJgnwbwmEJp2ysjLrTdq
email:
special_instructions:
currency: USD
@@ -1168,8 +1170,6 @@ paths:
item_count: 0
item_total: '0.0'
display_item_total: "$0.00"
- ship_total: '0.0'
- display_ship_total: "$0.00"
adjustment_total: '0.0'
display_adjustment_total: "$0.00"
promo_total: '0.0'
@@ -1182,8 +1182,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '0.0'
display_total: "$0.00"
- created_at: '2026-03-16T11:42:05.981Z'
- updated_at: '2026-03-16T11:42:05.981Z'
+ created_at: '2026-03-16T21:05:41.289Z'
+ updated_at: '2026-03-16T21:05:41.289Z'
+ delivery_total: '0.0'
+ display_delivery_total: "$0.00"
current_step: address
completed_steps: []
requirements:
@@ -1201,7 +1203,7 @@ paths:
message: Select a shipping method for all shipments
promotions: []
items: []
- shipments: []
+ fulfillments: []
payments: []
bill_address:
ship_address:
@@ -1290,17 +1292,15 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R734543831
- token: FdfRrq4gBGXE6Q9XjzmuMNLfkMaJH3QoHmu
+ number: R734523819
+ token: ePZou5gcY1f5hBDxzegkVosY6JSCGGU1iJU
special_instructions:
currency: USD
locale: en
item_count: 1
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'
@@ -1313,8 +1313,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-16T11:42:06.262Z'
- updated_at: '2026-03-16T11:42:06.314Z'
+ created_at: '2026-03-16T21:05:41.570Z'
+ updated_at: '2026-03-16T21:05:41.625Z'
+ delivery_total: '100.0'
+ display_delivery_total: "$100.00"
current_step: address
completed_steps: []
requirements:
@@ -1327,8 +1329,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 59838
- slug: product-59838
+ name: Product 5902
+ slug: product-5902
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1347,46 +1349,47 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:06.294Z'
- updated_at: '2026-03-16T11:42:06.294Z'
+ created_at: '2026-03-16T21:05:41.602Z'
+ updated_at: '2026-03-16T21:05:41.602Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
- shipments:
- - id: ship_UkLWZg9DAJ
- number: H54892494980
- state: pending
+ fulfillments:
+ - id: ful_UkLWZg9DAJ
+ number: H36464569706
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- shipped_at:
- created_at: '2026-03-16T11:42:06.298Z'
- updated_at: '2026-03-16T11:42:06.312Z'
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ created_at: '2026-03-16T21:05:41.607Z'
+ updated_at: '2026-03-16T21:05:41.623Z'
+ status: pending
+ fulfillment_type: shipping
+ fulfilled_at:
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_47
- name: Janetta Willms
+ name: Anjelica Carter
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
country_iso: US
country_name: United States of America
state_text: STATE_ABBR_47
- shipping_rates:
- - id: shpr_UkLWZg9DAJ
- shipping_method_id: shpm_UkLWZg9DAJ
+ delivery_rates:
+ - id: dr_UkLWZg9DAJ
+ delivery_method_id: dm_UkLWZg9DAJ
name: UPS Ground
selected: true
cost: '100.0'
display_cost: "$100.00"
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
payments: []
@@ -1506,17 +1509,15 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R504503846
- token: SQMBuPzUDarhEmJW5eDLNVWGPietZKKGryM
+ number: R201782076
+ token: shCnTcNjvA9sFtgc2rSSwE3oXtLyCHhN8zu
special_instructions: Leave at door
currency: USD
locale: en
item_count: 1
item_total: '19.99'
display_item_total: "$19.99"
- ship_total: '10.0'
- display_ship_total: "$10.00"
adjustment_total: '0.0'
display_adjustment_total: "$0.00"
promo_total: '0.0'
@@ -1529,8 +1530,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '29.99'
display_total: "$29.99"
- created_at: '2026-03-16T11:42:06.890Z'
- updated_at: '2026-03-16T11:42:07.042Z'
+ created_at: '2026-03-16T21:05:42.199Z'
+ updated_at: '2026-03-16T21:05:42.344Z'
+ delivery_total: '10.0'
+ display_delivery_total: "$10.00"
current_step: payment
completed_steps:
- address
@@ -1545,8 +1548,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 69382
- slug: product-69382
+ name: Product 6913
+ slug: product-6913
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -1565,46 +1568,47 @@ paths:
discounted_amount: '19.99'
display_discounted_amount: "$19.99"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:06.921Z'
- updated_at: '2026-03-16T11:42:06.997Z'
+ created_at: '2026-03-16T21:05:42.227Z'
+ updated_at: '2026-03-16T21:05:42.299Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
- shipments:
- - id: ship_gbHJdmfrXB
- number: H11758386245
- state: pending
+ fulfillments:
+ - id: ful_gbHJdmfrXB
+ number: H63171477143
tracking:
tracking_url:
cost: '10.0'
display_cost: "$10.00"
- shipped_at:
- created_at: '2026-03-16T11:42:07.015Z'
- updated_at: '2026-03-16T11:42:07.028Z'
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ created_at: '2026-03-16T21:05:42.317Z'
+ updated_at: '2026-03-16T21:05:42.330Z'
+ status: pending
+ fulfillment_type: shipping
+ fulfilled_at:
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_49
- name: Sherrell Wintheiser
+ name: Moira Huels
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
country_iso: US
country_name: United States of America
state_text: STATE_ABBR_49
- shipping_rates:
- - id: shpr_gbHJdmfrXB
- shipping_method_id: shpm_UkLWZg9DAJ
+ delivery_rates:
+ - id: dr_gbHJdmfrXB
+ delivery_method_id: dm_UkLWZg9DAJ
name: UPS Ground
selected: true
cost: '10.0'
display_cost: "$10.00"
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
payments: []
@@ -1811,17 +1815,15 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R645646809
- token: NR2WHSSdvEdvT32QiHz6cmDxJM7nPZeTWRt
+ number: R580650409
+ token: RzBYG4Pjz1Go3QYhQc8HTkbHkTG7AXvnbRU
special_instructions:
currency: USD
locale: en
item_count: 1
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'
@@ -1834,8 +1836,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-16T11:42:07.729Z'
- updated_at: '2026-03-16T11:42:07.797Z'
+ created_at: '2026-03-16T21:05:42.992Z'
+ updated_at: '2026-03-16T21:05:43.053Z'
+ delivery_total: '100.0'
+ display_delivery_total: "$100.00"
current_step: address
completed_steps: []
requirements:
@@ -1848,8 +1852,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 84356
- slug: product-84356
+ name: Product 82503
+ slug: product-82503
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1868,46 +1872,47 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:07.772Z'
- updated_at: '2026-03-16T11:42:07.772Z'
+ created_at: '2026-03-16T21:05:43.031Z'
+ updated_at: '2026-03-16T21:05:43.031Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
- shipments:
- - id: ship_UkLWZg9DAJ
- number: H79543816122
- state: pending
+ fulfillments:
+ - id: ful_UkLWZg9DAJ
+ number: H61633942307
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- shipped_at:
- created_at: '2026-03-16T11:42:07.778Z'
- updated_at: '2026-03-16T11:42:07.795Z'
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ created_at: '2026-03-16T21:05:43.037Z'
+ updated_at: '2026-03-16T21:05:43.051Z'
+ status: pending
+ fulfillment_type: shipping
+ fulfilled_at:
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_57
- name: Karena Keebler
+ name: Gayle Wilkinson
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
country_iso: US
country_name: United States of America
state_text: STATE_ABBR_57
- shipping_rates:
- - id: shpr_UkLWZg9DAJ
- shipping_method_id: shpm_UkLWZg9DAJ
+ delivery_rates:
+ - id: dr_UkLWZg9DAJ
+ delivery_method_id: dm_UkLWZg9DAJ
name: UPS Ground
selected: true
cost: '100.0'
display_cost: "$100.00"
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
payments: []
@@ -2011,18 +2016,14 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R423170020
+ number: R928550732
special_instructions:
currency: USD
locale: en
item_count: 1
- shipment_state: backorder
- payment_state: paid
item_total: '19.99'
display_item_total: "$19.99"
- ship_total: '10.0'
- display_ship_total: "$10.00"
adjustment_total: '0.0'
display_adjustment_total: "$0.00"
promo_total: '0.0'
@@ -2035,17 +2036,21 @@ paths:
display_additional_tax_total: "$0.00"
total: '29.99'
display_total: "$29.99"
- completed_at: '2026-03-16T11:42:09.278Z'
- created_at: '2026-03-16T11:42:09.067Z'
- updated_at: '2026-03-16T11:42:09.278Z'
+ completed_at: '2026-03-16T21:05:44.399Z'
+ created_at: '2026-03-16T21:05:44.190Z'
+ updated_at: '2026-03-16T21:05:44.399Z'
+ fulfillment_status: backorder
+ payment_status: paid
+ delivery_total: '10.0'
+ display_delivery_total: "$10.00"
promotions: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 108826
- slug: product-108826
+ name: Product 102686
+ slug: product-102686
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -2064,58 +2069,59 @@ paths:
discounted_amount: '19.99'
display_discounted_amount: "$19.99"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:09.098Z'
- updated_at: '2026-03-16T11:42:09.282Z'
+ created_at: '2026-03-16T21:05:44.216Z'
+ updated_at: '2026-03-16T21:05:44.402Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
- shipments:
- - id: ship_gbHJdmfrXB
- number: H38566815614
- state: pending
+ fulfillments:
+ - id: ful_gbHJdmfrXB
+ number: H51787887644
tracking:
tracking_url:
cost: '10.0'
display_cost: "$10.00"
- shipped_at:
- created_at: '2026-03-16T11:42:09.174Z'
- updated_at: '2026-03-16T11:42:09.273Z'
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ created_at: '2026-03-16T21:05:44.290Z'
+ updated_at: '2026-03-16T21:05:44.394Z'
+ status: pending
+ fulfillment_type: shipping
+ fulfilled_at:
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_63
- name: Alejandro Hermann
+ name: Oretha Sporer
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
country_iso: US
country_name: United States of America
state_text: STATE_ABBR_63
- shipping_rates:
- - id: shpr_gbHJdmfrXB
- shipping_method_id: shpm_UkLWZg9DAJ
+ delivery_rates:
+ - id: dr_gbHJdmfrXB
+ delivery_method_id: dm_UkLWZg9DAJ
name: UPS Ground
selected: true
cost: '10.0'
display_cost: "$10.00"
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
payments:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- state: completed
response_code: '12345'
- number: PNDK0HIN
+ number: PBXCMH8R
amount: '29.99'
display_amount: "$29.99"
- created_at: '2026-03-16T11:42:09.237Z'
- updated_at: '2026-03-16T11:42:09.258Z'
+ created_at: '2026-03-16T21:05:44.356Z'
+ updated_at: '2026-03-16T21:05:44.379Z'
+ status: completed
source_type: credit_card
source_id: card_UkLWZg9DAJ
source:
@@ -2247,8 +2253,8 @@ paths:
meta_description:
meta_keywords:
children_count: 1
- created_at: '2026-03-16T11:42:09.914Z'
- updated_at: '2026-03-16T11:42:09.960Z'
+ created_at: '2026-03-16T21:05:45.039Z'
+ updated_at: '2026-03-16T21:05:45.095Z'
parent_id:
description: ''
description_html: ''
@@ -2266,8 +2272,8 @@ paths:
meta_description:
meta_keywords:
children_count: 1
- created_at: '2026-03-16T11:42:09.922Z'
- updated_at: '2026-03-16T11:42:09.960Z'
+ created_at: '2026-03-16T21:05:45.047Z'
+ updated_at: '2026-03-16T21:05:45.094Z'
parent_id: ctg_UkLWZg9DAJ
description: ''
description_html: ''
@@ -2285,8 +2291,8 @@ paths:
meta_description:
meta_keywords:
children_count: 0
- created_at: '2026-03-16T11:42:09.931Z'
- updated_at: '2026-03-16T11:42:09.936Z'
+ created_at: '2026-03-16T21:05:45.055Z'
+ updated_at: '2026-03-16T21:05:45.060Z'
parent_id: ctg_gbHJdmfrXB
description: ''
description_html: ''
@@ -2387,8 +2393,8 @@ paths:
meta_description:
meta_keywords:
children_count: 1
- created_at: '2026-03-16T11:42:10.323Z'
- updated_at: '2026-03-16T11:42:10.356Z'
+ created_at: '2026-03-16T21:05:45.451Z'
+ updated_at: '2026-03-16T21:05:45.484Z'
parent_id: ctg_UkLWZg9DAJ
description: ''
description_html: ''
@@ -2515,17 +2521,19 @@ paths:
example:
data:
- id: prod_UkLWZg9DAJ
- name: Product 199134
+ name: Product 194991
description: |-
- Distinctio ipsum totam optio impedit nobis. Voluptatum sapiente ab quidem ullam neque amet. Natus qui provident sunt occaecati suscipit eveniet. Sint voluptas aperiam inventore alias voluptatum voluptates.
- Ab a voluptas similique ratione eius omnis asperiores dicta. Alias atque corporis nobis doloremque facilis. Praesentium similique vero cupiditate voluptas inventore veritatis atque. Explicabo inventore illum fugit totam.
- slug: product-199134
+ Placeat dignissimos quas non repellat modi ad laborum laboriosam. Ad blanditiis quae rem deserunt molestiae quidem est. Laboriosam amet blanditiis architecto autem deserunt impedit. Alias modi nemo praesentium nam. In laudantium reprehenderit maxime perspiciatis quos non.
+ Facilis eveniet id iure soluta voluptatum nulla tenetur incidunt. Esse nesciunt odit quibusdam similique sint eaque. Aspernatur placeat harum molestias soluta saepe.
+ Quia saepe temporibus veritatis provident debitis ipsam nisi eligendi. Officia corporis dicta necessitatibus quisquam. Consectetur placeat delectus quod excepturi quis. Totam at officiis iure iusto in doloremque.
+ Maxime ullam quasi cupiditate assumenda. Quia nesciunt ducimus quis nemo doloremque hic. At laborum dicta nemo quaerat aut tempora. Dolorem nihil animi expedita adipisci in fuga inventore iste. Iure commodi voluptas eveniet accusantium cumque suscipit maiores.
+ slug: product-194991
meta_description:
meta_keywords:
variant_count: 0
- available_on: '2025-03-16T11:42:10.781Z'
- created_at: '2026-03-16T11:42:10.794Z'
- updated_at: '2026-03-16T11:42:10.807Z'
+ available_on: '2025-03-16T21:05:45.904Z'
+ created_at: '2026-03-16T21:05:45.917Z'
+ updated_at: '2026-03-16T21:05:45.928Z'
purchasable: true
in_stock: false
backorderable: true
@@ -2795,17 +2803,15 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R979204925
- token: KQSk4bW8gYhDWB97YXPPXQ64DHh2wzmPcVN
+ number: R323688262
+ token: Kz8x88vcVaquiTFbRRaw5xTFAEp5GYAQs4H
special_instructions:
currency: USD
locale: en
item_count: 1
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'
@@ -2818,8 +2824,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-16T11:42:12.519Z'
- updated_at: '2026-03-16T11:42:12.670Z'
+ created_at: '2026-03-16T21:05:47.671Z'
+ updated_at: '2026-03-16T21:05:47.806Z'
+ delivery_total: '100.0'
+ display_delivery_total: "$100.00"
current_step: address
completed_steps: []
requirements: []
@@ -2829,8 +2837,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 234469
- slug: product-234469
+ name: Product 235886
+ slug: product-235886
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -2849,58 +2857,59 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:12.568Z'
- updated_at: '2026-03-16T11:42:12.568Z'
+ created_at: '2026-03-16T21:05:47.713Z'
+ updated_at: '2026-03-16T21:05:47.713Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
- shipments:
- - id: ship_UkLWZg9DAJ
- number: H07824285599
- state: pending
+ fulfillments:
+ - id: ful_UkLWZg9DAJ
+ number: H88066952217
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- shipped_at:
- created_at: '2026-03-16T11:42:12.579Z'
- updated_at: '2026-03-16T11:42:12.603Z'
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ created_at: '2026-03-16T21:05:47.723Z'
+ updated_at: '2026-03-16T21:05:47.744Z'
+ status: pending
+ fulfillment_type: shipping
+ fulfilled_at:
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_85
- name: Tracy Trantow
+ name: Clemmie Haley
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
country_iso: US
country_name: United States of America
state_text: STATE_ABBR_85
- shipping_rates:
- - id: shpr_UkLWZg9DAJ
- shipping_method_id: shpm_UkLWZg9DAJ
+ delivery_rates:
+ - id: dr_UkLWZg9DAJ
+ delivery_method_id: dm_UkLWZg9DAJ
name: UPS Ground
selected: true
cost: '100.0'
display_cost: "$100.00"
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
payments:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- state: checkout
- response_code: 1-SC-20260316114212663794
- number: PUZIDS8M
+ response_code: 1-SC-20260316210547800245
+ number: P3V084KX
amount: '50.0'
display_amount: "$50.00"
- created_at: '2026-03-16T11:42:12.665Z'
- updated_at: '2026-03-16T11:42:12.665Z'
+ created_at: '2026-03-16T21:05:47.801Z'
+ updated_at: '2026-03-16T21:05:47.801Z'
+ status: checkout
source_type: store_credit
source_id: credit_UkLWZg9DAJ
source:
@@ -3043,17 +3052,15 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R380290666
- token: JJqUnbpdK4uJfdGf4uQvsWxJ2VCDRZj3sXw
+ number: R432811736
+ token: 8ayMKeL3vRxvVSbbTA2kMqBiJBwgr6MuoPT
special_instructions:
currency: USD
locale: en
item_count: 1
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'
@@ -3066,8 +3073,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-16T11:42:13.837Z'
- updated_at: '2026-03-16T11:42:13.934Z'
+ created_at: '2026-03-16T21:05:48.958Z'
+ updated_at: '2026-03-16T21:05:49.055Z'
+ delivery_total: '100.0'
+ display_delivery_total: "$100.00"
current_step: address
completed_steps: []
requirements:
@@ -3080,8 +3089,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 251943
- slug: product-251943
+ name: Product 255487
+ slug: product-255487
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -3100,46 +3109,47 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:13.864Z'
- updated_at: '2026-03-16T11:42:13.930Z'
+ created_at: '2026-03-16T21:05:48.984Z'
+ updated_at: '2026-03-16T21:05:49.051Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
- shipments:
- - id: ship_UkLWZg9DAJ
- number: H93851004237
- state: pending
+ fulfillments:
+ - id: ful_UkLWZg9DAJ
+ number: H44757806342
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- shipped_at:
- created_at: '2026-03-16T11:42:13.868Z'
- updated_at: '2026-03-16T11:42:13.881Z'
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ created_at: '2026-03-16T21:05:48.989Z'
+ updated_at: '2026-03-16T21:05:49.002Z'
+ status: pending
+ fulfillment_type: shipping
+ fulfilled_at:
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_93
- name: Maya Huels
+ name: Grayce Spinka
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
country_iso: US
country_name: United States of America
state_text: STATE_ABBR_93
- shipping_rates:
- - id: shpr_UkLWZg9DAJ
- shipping_method_id: shpm_UkLWZg9DAJ
+ delivery_rates:
+ - id: dr_UkLWZg9DAJ
+ delivery_method_id: dm_UkLWZg9DAJ
name: UPS Ground
selected: true
cost: '100.0'
display_cost: "$100.00"
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
payments: []
@@ -3590,16 +3600,16 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6ImY2ZTZlYmFkLTQwZDgtNDViZi1hOGVlLThiM2IyYWU0NjcxZSIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczNjY0OTM5fQ.Cw26SBmNlH613s9ji0WNPUOmmTtgezQooaIWsWF84Kk
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjBhNWM1YzEzLTY0MDktNGQ2ZS1iZjk2LTQ2ZGNmOGQzNzdiMiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczNjk4NzU0fQ.2Vyl0RYgRoVs-jELfNJRO4P5ieTQs2-ii85bshQnoXk
user:
id: cus_UkLWZg9DAJ
- first_name: Antonietta
- last_name: Deckow
+ first_name: Rubye
+ last_name: Dietrich
phone:
accepts_email_marketing: false
- created_at: '2026-03-16T11:42:18.809Z'
- updated_at: '2026-03-16T11:42:19.086Z'
+ created_at: '2026-03-16T21:05:53.818Z'
+ updated_at: '2026-03-16T21:05:54.087Z'
addresses: []
default_billing_address:
default_shipping_address:
@@ -3687,18 +3697,14 @@ paths:
example:
data:
- id: or_UkLWZg9DAJ
- number: R294365647
+ number: R890258292
special_instructions:
currency: USD
locale: en
item_count: 1
- shipment_state:
- payment_state:
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'
@@ -3711,17 +3717,21 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- completed_at: '2026-03-16T11:42:19.985Z'
- created_at: '2026-03-16T11:42:19.922Z'
- updated_at: '2026-03-16T11:42:19.985Z'
+ completed_at: '2026-03-16T21:05:54.980Z'
+ created_at: '2026-03-16T21:05:54.924Z'
+ updated_at: '2026-03-16T21:05:54.980Z'
+ fulfillment_status:
+ payment_status:
+ delivery_total: '100.0'
+ display_delivery_total: "$100.00"
promotions: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 278791
- slug: product-278791
+ name: Product 276296
+ slug: product-276296
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -3740,46 +3750,47 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:19.960Z'
- updated_at: '2026-03-16T11:42:19.960Z'
+ created_at: '2026-03-16T21:05:54.959Z'
+ updated_at: '2026-03-16T21:05:54.959Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
- shipments:
- - id: ship_UkLWZg9DAJ
- number: H73483267054
- state: pending
+ fulfillments:
+ - id: ful_UkLWZg9DAJ
+ number: H62894885132
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- shipped_at:
- created_at: '2026-03-16T11:42:19.967Z'
- updated_at: '2026-03-16T11:42:19.983Z'
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ created_at: '2026-03-16T21:05:54.964Z'
+ updated_at: '2026-03-16T21:05:54.978Z'
+ status: pending
+ fulfillment_type: shipping
+ fulfilled_at:
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_113
- name: Shizuko Strosin
+ name: Trevor Dach
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
country_iso: US
country_name: United States of America
state_text: STATE_ABBR_113
- shipping_rates:
- - id: shpr_gbHJdmfrXB
- shipping_method_id: shpm_UkLWZg9DAJ
+ delivery_rates:
+ - id: dr_gbHJdmfrXB
+ delivery_method_id: dm_UkLWZg9DAJ
name: UPS Ground
selected: true
cost: '10.0'
display_cost: "$10.00"
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
payments: []
@@ -3884,18 +3895,14 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R079052985
+ number: R914413496
special_instructions:
currency: USD
locale: en
item_count: 1
- shipment_state:
- payment_state:
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'
@@ -3908,17 +3915,21 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- completed_at: '2026-03-16T11:42:20.665Z'
- created_at: '2026-03-16T11:42:20.616Z'
- updated_at: '2026-03-16T11:42:20.665Z'
+ completed_at: '2026-03-16T21:05:55.644Z'
+ created_at: '2026-03-16T21:05:55.598Z'
+ updated_at: '2026-03-16T21:05:55.643Z'
+ fulfillment_status:
+ payment_status:
+ delivery_total: '100.0'
+ display_delivery_total: "$100.00"
promotions: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 298764
- slug: product-298764
+ name: Product 298451
+ slug: product-298451
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -3937,46 +3948,47 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:20.646Z'
- updated_at: '2026-03-16T11:42:20.646Z'
+ created_at: '2026-03-16T21:05:55.625Z'
+ updated_at: '2026-03-16T21:05:55.625Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
- shipments:
- - id: ship_UkLWZg9DAJ
- number: H31898065583
- state: pending
+ fulfillments:
+ - id: ful_UkLWZg9DAJ
+ number: H61924215221
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- shipped_at:
- created_at: '2026-03-16T11:42:20.650Z'
- updated_at: '2026-03-16T11:42:20.663Z'
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ created_at: '2026-03-16T21:05:55.629Z'
+ updated_at: '2026-03-16T21:05:55.642Z'
+ status: pending
+ fulfillment_type: shipping
+ fulfilled_at:
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_119
- name: Lyman Doyle
+ name: Larita Volkman
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
country_iso: US
country_name: United States of America
state_text: STATE_ABBR_119
- shipping_rates:
- - id: shpr_gbHJdmfrXB
- shipping_method_id: shpm_UkLWZg9DAJ
+ delivery_rates:
+ - id: dr_gbHJdmfrXB
+ delivery_method_id: dm_UkLWZg9DAJ
name: UPS Ground
selected: true
cost: '10.0'
display_cost: "$10.00"
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
payments: []
@@ -4067,7 +4079,7 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6ImI2YTQ1YjIzLTFmNTAtNGNlZC04MGYzLTkyYzJhNTAzNzhhOSIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczNjY0OTQxfQ.Hbdwqg6sS8oS9UGKeCp-zGsD98oUKq859M23kq0mI2A
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjI4YTVhZTM2LTY0NGYtNDY2ZC04OTA2LTg4MWY3NDc1ZDZiMiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczNjk4NzU2fQ.pp0Oh3oAAnNWCvcsAIEA2x_Ju6q46sUNQseBQ4nNJrk
user:
id: cus_UkLWZg9DAJ
@@ -4075,8 +4087,8 @@ paths:
last_name: Doe
phone: "+1234567890"
accepts_email_marketing: true
- created_at: '2026-03-16T11:42:21.838Z'
- updated_at: '2026-03-16T11:42:21.838Z'
+ created_at: '2026-03-16T21:05:56.807Z'
+ updated_at: '2026-03-16T21:05:56.807Z'
addresses: []
default_billing_address:
default_shipping_address:
@@ -4180,13 +4192,13 @@ paths:
application/json:
example:
id: cus_UkLWZg9DAJ
- first_name: Jeramy
- last_name: Fritsch
+ first_name: Tatiana
+ last_name: Jaskolski
phone: 555-555-0199
accepts_email_marketing: false
- created_at: '2026-03-16T11:42:22.380Z'
- updated_at: '2026-03-16T11:42:22.649Z'
+ created_at: '2026-03-16T21:05:57.344Z'
+ updated_at: '2026-03-16T21:05:57.618Z'
addresses:
- id: addr_gbHJdmfrXB
firstname: John
@@ -4310,13 +4322,13 @@ paths:
application/json:
example:
id: cus_UkLWZg9DAJ
first_name: Updated
last_name: Name
phone: 555-555-0199
accepts_email_marketing: false
- created_at: '2026-03-16T11:42:22.943Z'
- updated_at: '2026-03-16T11:42:23.223Z'
+ created_at: '2026-03-16T21:05:57.908Z'
+ updated_at: '2026-03-16T21:05:58.183Z'
addresses:
- id: addr_gbHJdmfrXB
firstname: John
@@ -4481,6 +4493,321 @@ paths:
application/octet-stream:
schema:
"$ref": "#/components/schemas/ErrorResponse"
+ "/api/v3/store/carts/{cart_id}/fulfillments":
+ get:
+ summary: List fulfillments
+ tags:
+ - Carts
+ security:
+ - api_key: []
+ bearer_auth: []
+ description: Returns all fulfillments with delivery rates for the cart.
+ x-codeSamples:
+ - lang: javascript
+ label: Spree SDK
+ source: |-
+ import { createClient } from '@spree/sdk'
+
+ const client = createClient({
+ baseUrl: 'https://your-store.com',
+ publishableKey: '<api-key>',
+ })
+
+ const fulfillments = await client.carts.fulfillments.list('cart_abc123', {
+ bearerToken: '<token>',
+ })
+ parameters:
+ - name: x-spree-api-key
+ in: header
+ required: true
+ schema:
+ type: string
+ - name: Authorization
+ in: header
+ required: false
+ schema:
+ type: string
+ - name: cart_id
+ in: path
+ required: true
+ description: Cart prefixed ID (e.g., cart_abc123)
+ schema:
+ type: string
+ - name: x-spree-token
+ in: header
+ required: false
+ description: Order token for guest access
+ schema:
+ type: string
+ responses:
+ '200':
+ description: fulfillments found
+ content:
+ application/json:
+ example:
+ data:
+ - id: ful_UkLWZg9DAJ
+ number: H59320952245
+ tracking: U10000
+ tracking_url:
+ cost: '100.0'
+ display_cost: "$100.00"
+ created_at: '2026-03-16T21:06:01.265Z'
+ updated_at: '2026-03-16T21:06:01.278Z'
+ status: pending
+ fulfillment_type: shipping
+ fulfilled_at:
+ delivery_method:
+ id: dm_UkLWZg9DAJ
+ name: UPS Ground
+ code: UPS_GROUND
+ stock_location:
+ id: sloc_UkLWZg9DAJ
+ state_abbr: STATE_ABBR_145
+ name: Diana Kautzer
+ address1: 1600 Pennsylvania Ave NW
+ city: Washington
+ zipcode: '20500'
+ country_iso: US
+ country_name: United States of America
+ state_text: STATE_ABBR_145
+ delivery_rates:
+ - id: dr_UkLWZg9DAJ
+ delivery_method_id: dm_UkLWZg9DAJ
+ name: UPS Ground
+ selected: true
+ cost: '100.0'
+ display_cost: "$100.00"
+ delivery_method:
+ id: dm_UkLWZg9DAJ
+ name: UPS Ground
+ code: UPS_GROUND
+ meta:
+ count: 1
+ "/api/v3/store/carts/{cart_id}/fulfillments/{id}":
+ patch:
+ summary: Select delivery rate for fulfillment
+ tags:
+ - Carts
+ security:
+ - api_key: []
+ bearer_auth: []
+ description: Selects a delivery rate for a specific fulfillment and auto-advances
+ checkout.
+ x-codeSamples:
+ - lang: javascript
+ label: Spree SDK
+ source: |-
+ import { createClient } from '@spree/sdk'
+
+ const client = createClient({
+ baseUrl: 'https://your-store.com',
+ publishableKey: '<api-key>',
+ })
+
+ const cart = await client.carts.fulfillments.update('cart_abc123', 'ful_abc123', {
+ selected_delivery_rate_id: 'dr_abc123',
+ }, {
+ bearerToken: '<token>',
+ })
+ parameters:
+ - name: x-spree-api-key
+ in: header
+ required: true
+ schema:
+ type: string
+ - name: Authorization
+ in: header
+ required: false
+ schema:
+ type: string
+ - name: cart_id
+ in: path
+ required: true
+ description: Cart prefixed ID
+ schema:
+ type: string
+ - name: id
+ in: path
+ required: true
+ description: Fulfillment ID
+ schema:
+ type: string
+ - name: x-spree-token
+ in: header
+ required: false
+ description: Order token for guest access
+ schema:
+ type: string
+ responses:
+ '200':
+ description: delivery rate selected, returns updated cart
+ content:
+ application/json:
+ example:
+ id: cart_UkLWZg9DAJ
+ number: R043342525
+ token: iGMhHS3mXPmFNgq3cPY14RygexGok37Y51H
+ special_instructions:
+ currency: USD
+ locale: en
+ item_count: 1
+ item_total: '10.0'
+ display_item_total: "$10.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"
+ created_at: '2026-03-16T21:06:01.849Z'
+ updated_at: '2026-03-16T21:06:01.936Z'
+ delivery_total: '100.0'
+ display_delivery_total: "$100.00"
+ current_step: payment
+ completed_steps:
+ - address
+ - delivery
+ requirements:
+ - step: payment
+ field: payment
+ message: Add a payment method
+ promotions: []
+ items:
+ - id: li_UkLWZg9DAJ
+ variant_id: variant_UkLWZg9DAJ
+ quantity: 1
+ currency: USD
+ name: Product 389883
+ slug: product-389883
+ 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-16T21:06:01.880Z'
+ updated_at: '2026-03-16T21:06:01.880Z'
+ compare_at_amount:
+ thumbnail_url:
+ option_values: []
+ digital_links: []
+ fulfillments:
+ - id: ful_UkLWZg9DAJ
+ number: H77952886417
+ tracking: U10000
+ tracking_url:
+ cost: '100.0'
+ display_cost: "$100.00"
+ created_at: '2026-03-16T21:06:01.885Z'
+ updated_at: '2026-03-16T21:06:01.920Z'
+ status: pending
+ fulfillment_type: shipping
+ fulfilled_at:
+ delivery_method:
+ id: dm_UkLWZg9DAJ
+ name: UPS Ground
+ code: UPS_GROUND
+ stock_location:
+ id: sloc_UkLWZg9DAJ
+ state_abbr: STATE_ABBR_149
+ name: Shanon Simonis
+ address1: 1600 Pennsylvania Ave NW
+ city: Washington
+ zipcode: '20500'
+ country_iso: US
+ country_name: United States of America
+ state_text: STATE_ABBR_149
+ delivery_rates:
+ - id: dr_UkLWZg9DAJ
+ delivery_method_id: dm_UkLWZg9DAJ
+ name: UPS Ground
+ selected: true
+ cost: '100.0'
+ display_cost: "$100.00"
+ delivery_method:
+ id: dm_UkLWZg9DAJ
+ name: UPS Ground
+ code: UPS_GROUND
+ payments: []
+ bill_address:
+ id: addr_EfhxLZ9ck8
+ firstname: John
+ lastname: Doe
+ full_name: John Doe
+ address1: 141 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_151
+ state_abbr: STATE_ABBR_151
+ quick_checkout: false
+ state_name: STATE_NAME_151
+ ship_address:
+ id: addr_VqXmZF31wY
+ firstname: John
+ lastname: Doe
+ full_name: John Doe
+ address1: 142 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_152
+ state_abbr: STATE_ABBR_152
+ quick_checkout: false
+ state_name: STATE_NAME_152
+ payment_methods: []
+ schema:
+ "$ref": "#/components/schemas/Cart"
+ '404':
+ description: delivery rate not found
+ content:
+ application/json:
+ example:
+ error:
+ code: record_not_found
+ message: Shipping rate not found
+ schema:
+ "$ref": "#/components/schemas/ErrorResponse"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ selected_delivery_rate_id:
+ type: string
+ example: dr_abc123
+ description: Delivery rate ID to select
+ required:
+ - selected_delivery_rate_id
"/api/v3/store/customer/gift_cards":
get:
summary: List gift cards
@@ -4540,8 +4867,8 @@ paths:
example:
data:
- id: gc_UkLWZg9DAJ
- code: 28CABF0C75127A6A
- state: active
+ code: 752556435CCE4F73
+ status: active
currency: USD
amount: '10.0'
amount_used: '0.0'
@@ -4554,8 +4881,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-03-16T11:42:26.268Z'
- updated_at: '2026-03-16T11:42:26.268Z'
+ created_at: '2026-03-16T21:06:03.105Z'
+ updated_at: '2026-03-16T21:06:03.105Z'
meta:
page: 1
limit: 25
@@ -4638,8 +4965,8 @@ paths:
application/json:
example:
id: gc_UkLWZg9DAJ
- code: A8F57643BDF60F5F
- state: active
+ code: 61C15847E6F6611B
+ status: active
currency: USD
amount: '10.0'
amount_used: '0.0'
@@ -4652,8 +4979,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-03-16T11:42:27.349Z'
- updated_at: '2026-03-16T11:42:27.349Z'
+ created_at: '2026-03-16T21:06:04.178Z'
+ updated_at: '2026-03-16T21:06:04.178Z'
schema:
"$ref": "#/components/schemas/GiftCard"
'404':
@@ -4730,17 +5057,15 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R452121802
- token: grWFKTAFcGQo6oZmZnr6tKM414FiJxQSACU
+ number: R532870928
+ token: pEsQz82NoQtUdAxiwdzeYPmCd7TjoNVcXqm
special_instructions:
currency: USD
locale: en
item_count: 2
item_total: '29.99'
display_item_total: "$29.99"
- ship_total: '0.0'
- display_ship_total: "$0.00"
adjustment_total: '0.0'
display_adjustment_total: "$0.00"
promo_total: '0.0'
@@ -4753,8 +5078,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '29.99'
display_total: "$29.99"
- created_at: '2026-03-16T11:42:29.094Z'
- updated_at: '2026-03-16T11:42:29.196Z'
+ created_at: '2026-03-16T21:06:05.917Z'
+ updated_at: '2026-03-16T21:06:06.061Z'
+ delivery_total: '0.0'
+ display_delivery_total: "$0.00"
current_step: address
completed_steps: []
requirements:
@@ -4773,8 +5100,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 399968
- slug: product-399968
+ name: Product 424715
+ slug: product-424715
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -4793,8 +5120,8 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:29.118Z'
- updated_at: '2026-03-16T11:42:29.118Z'
+ created_at: '2026-03-16T21:06:05.959Z'
+ updated_at: '2026-03-16T21:06:05.959Z'
compare_at_amount:
thumbnail_url:
option_values: []
@@ -4803,8 +5130,8 @@ paths:
variant_id: variant_gbHJdmfrXB
quantity: 1
currency: USD
- name: Product 404361
- slug: product-404361
+ name: Product 438494
+ slug: product-438494
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -4823,20 +5150,20 @@ paths:
discounted_amount: '19.99'
display_discounted_amount: "$19.99"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:29.158Z'
- updated_at: '2026-03-16T11:42:29.158Z'
+ created_at: '2026-03-16T21:06:06.025Z'
+ updated_at: '2026-03-16T21:06:06.025Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
- shipments: []
+ fulfillments: []
payments: []
bill_address:
id: addr_EfhxLZ9ck8
firstname: John
lastname: Doe
full_name: John Doe
- address1: 148 Lovely Street
+ address1: 160 Lovely Street
address2: Northwest
city: Herndon
zipcode: '35005'
@@ -4844,10 +5171,10 @@ paths:
company: Company
country_name: United States of America
country_iso: US
- state_text: STATE_ABBR_158
- state_abbr: STATE_ABBR_158
+ state_text: STATE_ABBR_170
+ state_abbr: STATE_ABBR_170
quick_checkout: false
- state_name: STATE_NAME_158
+ state_name: STATE_NAME_170
ship_address:
payment_methods: []
schema:
@@ -4944,17 +5271,15 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R198416438
- token: NnLWSHFmPCYkAzer8M5CJKZ8mfu4JPTYHUv
+ number: R355939240
+ token: tsfmUD7M9sJArJfUqG513Vd8QLR9A7PUu28
special_instructions:
currency: USD
locale: en
item_count: 0
item_total: '0.0'
display_item_total: "$0.00"
- ship_total: '0.0'
- display_ship_total: "$0.00"
adjustment_total: '0.0'
display_adjustment_total: "$0.00"
promo_total: '0.0'
@@ -4967,8 +5292,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '0.0'
display_total: "$0.00"
- created_at: '2026-03-16T11:42:30.955Z'
- updated_at: '2026-03-16T11:42:30.981Z'
+ created_at: '2026-03-16T21:06:07.790Z'
+ updated_at: '2026-03-16T21:06:07.824Z'
+ delivery_total: '0.0'
+ display_delivery_total: "$0.00"
current_step: address
completed_steps: []
requirements:
@@ -4984,8 +5311,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 436993
- slug: product-436993
+ name: Product 463267
+ slug: product-463267
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -5004,20 +5331,20 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:30.981Z'
- updated_at: '2026-03-16T11:42:30.997Z'
+ created_at: '2026-03-16T21:06:07.823Z'
+ updated_at: '2026-03-16T21:06:07.841Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
- shipments: []
+ fulfillments: []
payments: []
bill_address:
id: addr_EfhxLZ9ck8
firstname: John
lastname: Doe
full_name: John Doe
- address1: 157 Lovely Street
+ address1: 169 Lovely Street
address2: Northwest
city: Herndon
zipcode: '35005'
@@ -5025,10 +5352,10 @@ paths:
company: Company
country_name: United States of America
country_iso: US
- state_text: STATE_ABBR_167
- state_abbr: STATE_ABBR_167
+ state_text: STATE_ABBR_179
+ state_abbr: STATE_ABBR_179
quick_checkout: false
- state_name: STATE_NAME_167
+ state_name: STATE_NAME_179
ship_address:
payment_methods: []
schema:
@@ -5105,17 +5432,15 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R559013003
- token: 3EjQ6SbAtYkmZXxS6py5axLK3STcURbj7QP
+ number: R457757211
+ token: kPESU6hSYgHugg3J64qZq5mNdjYgF1YXBRM
special_instructions:
currency: USD
locale: en
item_count: 0
item_total: '0.0'
display_item_total: "$0.00"
- ship_total: '0.0'
- display_ship_total: "$0.00"
adjustment_total: '0.0'
display_adjustment_total: "$0.00"
promo_total: '0.0'
@@ -5128,8 +5453,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '0.0'
display_total: "$0.00"
- created_at: '2026-03-16T11:42:31.562Z'
- updated_at: '2026-03-16T11:42:31.646Z'
+ created_at: '2026-03-16T21:06:08.387Z'
+ updated_at: '2026-03-16T21:06:08.432Z'
+ delivery_total: '0.0'
+ display_delivery_total: "$0.00"
current_step: address
completed_steps: []
requirements:
@@ -5144,14 +5471,14 @@ paths:
message: Select a shipping method for all shipments
promotions: []
items: []
- shipments: []
+ fulfillments: []
payments: []
bill_address:
id: addr_EfhxLZ9ck8
firstname: John
lastname: Doe
full_name: John Doe
- address1: 160 Lovely Street
+ address1: 172 Lovely Street
address2: Northwest
city: Herndon
zipcode: '35005'
@@ -5159,10 +5486,10 @@ paths:
company: Company
country_name: United States of America
country_iso: US
- state_text: STATE_ABBR_170
- state_abbr: STATE_ABBR_170
+ state_text: STATE_ABBR_182
+ state_abbr: STATE_ABBR_182
quick_checkout: false
- state_name: STATE_NAME_170
+ state_name: STATE_NAME_182
ship_address:
payment_methods: []
schema:
@@ -5308,12 +5635,12 @@ paths:
- fr
countries:
- iso: DE
- iso3: IS42
+ iso3: IS45
name: Germany
states_required: false
zipcode_required: true
- iso: FR
- iso3: IS43
+ iso3: IS46
name: France
states_required: false
zipcode_required: true
@@ -5392,12 +5719,12 @@ paths:
- fr
countries:
- iso: DE
- iso3: IS46
+ iso3: IS49
name: Germany
states_required: false
zipcode_required: true
- iso: FR
- iso3: IS47
+ iso3: IS50
name: France
states_required: false
zipcode_required: true
@@ -5472,12 +5799,12 @@ paths:
- fr
countries:
- iso: DE
- iso3: IS50
+ iso3: IS53
name: Germany
states_required: false
zipcode_required: true
- iso: FR
- iso3: IS51
+ iso3: IS54
name: France
states_required: false
zipcode_required: true
@@ -5541,12 +5868,12 @@ paths:
example:
data:
- iso: FR
- iso3: IS55
+ iso3: IS58
name: France
states_required: false
zipcode_required: true
- iso: DE
- iso3: IS54
+ iso3: IS57
name: Germany
states_required: false
zipcode_required: true
@@ -5681,18 +6008,14 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R659779239
+ number: R455730542
special_instructions:
currency: USD
locale: en
item_count: 1
- shipment_state:
- payment_state:
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'
@@ -5705,17 +6028,21 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- completed_at: '2026-03-16T11:42:33.415Z'
- created_at: '2026-03-16T11:42:33.368Z'
- updated_at: '2026-03-16T11:42:33.414Z'
+ completed_at: '2026-03-16T21:06:10.090Z'
+ created_at: '2026-03-16T21:06:10.044Z'
+ updated_at: '2026-03-16T21:06:10.089Z'
+ fulfillment_status:
+ payment_status:
+ delivery_total: '100.0'
+ display_delivery_total: "$100.00"
promotions: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 472278
- slug: product-472278
+ name: Product 507771
+ slug: product-507771
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -5734,46 +6061,47 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:33.395Z'
- updated_at: '2026-03-16T11:42:33.395Z'
+ created_at: '2026-03-16T21:06:10.071Z'
+ updated_at: '2026-03-16T21:06:10.071Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
- shipments:
- - id: ship_UkLWZg9DAJ
- number: H36992806743
- state: pending
+ fulfillments:
+ - id: ful_UkLWZg9DAJ
+ number: H69761648707
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- shipped_at:
- created_at: '2026-03-16T11:42:33.400Z'
- updated_at: '2026-03-16T11:42:33.413Z'
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ created_at: '2026-03-16T21:06:10.075Z'
+ updated_at: '2026-03-16T21:06:10.087Z'
+ status: pending
+ fulfillment_type: shipping
+ fulfilled_at:
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
stock_location:
id: sloc_UkLWZg9DAJ
- state_abbr: STATE_ABBR_178
- name: Garry Stokes
+ state_abbr: STATE_ABBR_190
+ name: Brittani Kulas
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
country_iso: US
country_name: United States of America
- state_text: STATE_ABBR_178
- shipping_rates:
- - id: shpr_gbHJdmfrXB
- shipping_method_id: shpm_UkLWZg9DAJ
+ state_text: STATE_ABBR_190
+ delivery_rates:
+ - id: dr_gbHJdmfrXB
+ delivery_method_id: dm_UkLWZg9DAJ
name: UPS Ground
selected: true
cost: '10.0'
display_cost: "$10.00"
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
payments: []
@@ -5782,7 +6110,7 @@ paths:
firstname: John
lastname: Doe
full_name: John Doe
- address1: 168 Lovely Street
+ address1: 180 Lovely Street
address2: Northwest
city: Herndon
zipcode: '35005'
@@ -5790,16 +6118,16 @@ paths:
company: Company
country_name: United States of America
country_iso: US
- state_text: STATE_ABBR_178
- state_abbr: STATE_ABBR_178
+ state_text: STATE_ABBR_190
+ state_abbr: STATE_ABBR_190
quick_checkout: false
- state_name: STATE_NAME_178
+ state_name: STATE_NAME_190
ship_address:
id: addr_gbHJdmfrXB
firstname: John
lastname: Doe
full_name: John Doe
- address1: 169 Lovely Street
+ address1: 181 Lovely Street
address2: Northwest
city: Herndon
zipcode: '35005'
@@ -5807,10 +6135,10 @@ paths:
company: Company
country_name: United States of America
country_iso: US
- state_text: STATE_ABBR_179
- state_abbr: STATE_ABBR_179
+ state_text: STATE_ABBR_191
+ state_abbr: STATE_ABBR_191
quick_checkout: false
- state_name: STATE_NAME_179
+ state_name: STATE_NAME_191
schema:
"$ref": "#/components/schemas/Order"
'404':
@@ -5963,13 +6291,13 @@ paths:
id: ps_gbHJdmfrXB
status: pending
currency: USD
- external_id: bogus_daabaa50d1c57f13c5014881
+ external_id: bogus_a4175ad9df7e577d301652d3
external_data:
- client_secret: bogus_secret_e7e604a73544eb4e
+ client_secret: bogus_secret_381716f6c9ef9a10
customer_external_id:
expires_at:
- created_at: '2026-03-16T11:42:35.818Z'
- updated_at: '2026-03-16T11:42:35.818Z'
+ created_at: '2026-03-16T21:06:12.513Z'
+ updated_at: '2026-03-16T21:06:12.513Z'
amount: '110.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -6064,13 +6392,13 @@ paths:
id: ps_UkLWZg9DAJ
status: pending
currency: USD
- external_id: bogus_77fbd02f6677cef6ebe14fe3
+ external_id: bogus_d38720cface3323de29fad2f
external_data:
client_secret: secret_123
customer_external_id:
expires_at:
- created_at: '2026-03-16T11:42:36.405Z'
- updated_at: '2026-03-16T11:42:36.405Z'
+ created_at: '2026-03-16T21:06:13.117Z'
+ updated_at: '2026-03-16T21:06:13.117Z'
amount: '110.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -6127,13 +6455,13 @@ paths:
id: ps_UkLWZg9DAJ
status: pending
currency: USD
- external_id: bogus_30506623e48d658c98419dc3
+ external_id: bogus_6de0d0686874a70231befd8a
external_data:
client_secret: secret_123
customer_external_id:
expires_at:
- created_at: '2026-03-16T11:42:37.617Z'
- updated_at: '2026-03-16T11:42:37.631Z'
+ created_at: '2026-03-16T21:06:14.338Z'
+ updated_at: '2026-03-16T21:06:14.353Z'
amount: '50.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -6230,13 +6558,13 @@ paths:
id: ps_UkLWZg9DAJ
status: completed
currency: USD
- external_id: bogus_424ada87b0da602b935acd08
+ external_id: bogus_ffd72777e44cf22ae6467e10
external_data:
client_secret: secret_123
customer_external_id:
expires_at:
- created_at: '2026-03-16T11:42:38.221Z'
- updated_at: '2026-03-16T11:42:38.232Z'
+ created_at: '2026-03-16T21:06:14.940Z'
+ updated_at: '2026-03-16T21:06:14.952Z'
amount: '110.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -6316,11 +6644,11 @@ paths:
example:
id: pss_gbHJdmfrXB
status: pending
- external_id: bogus_seti_5c545f3dc7c5849d72ffc674
- external_client_secret: bogus_seti_secret_467a3b3ef01f86d7
+ external_id: bogus_seti_0649f632850638cd3ab52202
+ external_client_secret: bogus_seti_secret_106a665c9973c6e9
external_data: {}
- created_at: '2026-03-16T11:42:39.440Z'
- updated_at: '2026-03-16T11:42:39.440Z'
+ created_at: '2026-03-16T21:06:16.121Z'
+ updated_at: '2026-03-16T21:06:16.121Z'
payment_method_id: pm_UkLWZg9DAJ
payment_source_id:
payment_source_type:
@@ -6417,12 +6745,12 @@ paths:
example:
id: pss_UkLWZg9DAJ
status: pending
- external_id: seti_test_1a2c9705d0abdecef67304e3
- external_client_secret: seti_secret_d3c3962baa443c69e575a041
+ external_id: seti_test_d9b3b43940d723dd23549c50
+ external_client_secret: seti_secret_fb06f052ef6ae8e2e18b7f1a
external_data:
client_secret: secret_123
- created_at: '2026-03-16T11:42:41.069Z'
- updated_at: '2026-03-16T11:42:41.069Z'
+ created_at: '2026-03-16T21:06:17.807Z'
+ updated_at: '2026-03-16T21:06:17.807Z'
payment_method_id: pm_UkLWZg9DAJ
payment_source_id:
payment_source_type:
@@ -6495,12 +6823,12 @@ paths:
example:
id: pss_UkLWZg9DAJ
status: completed
- external_id: seti_test_ef6d5d09f94b0b678cc84d3c
- external_client_secret: seti_secret_f94fdb8a44d560744d38eb25
+ external_id: seti_test_d15551e05feb7f912f0e777c
+ external_client_secret: seti_secret_1cc6a08aff97d430972847df
external_data:
client_secret: secret_123
- created_at: '2026-03-16T11:42:42.156Z'
- updated_at: '2026-03-16T11:42:42.168Z'
+ created_at: '2026-03-16T21:06:18.914Z'
+ updated_at: '2026-03-16T21:06:18.926Z'
payment_method_id: pm_UkLWZg9DAJ
payment_source_id: card_UkLWZg9DAJ
payment_source_type: Spree::CreditCard
@@ -6586,13 +6914,13 @@ paths:
data:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- state: checkout
response_code: '12345'
- number: PYNZVFY8
+ number: PTVPNTNE
amount: '110.0'
display_amount: "$110.00"
- created_at: '2026-03-16T11:42:43.304Z'
- updated_at: '2026-03-16T11:42:43.304Z'
+ created_at: '2026-03-16T21:06:20.082Z'
+ updated_at: '2026-03-16T21:06:20.082Z'
+ status: checkout
source_type: credit_card
source_id: card_UkLWZg9DAJ
source:
@@ -6677,13 +7005,13 @@ paths:
example:
id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- state: checkout
response_code:
- number: PCY45KRA
+ number: PLG0D08T
amount: '110.0'
display_amount: "$110.00"
- created_at: '2026-03-16T11:42:43.912Z'
- updated_at: '2026-03-16T11:42:43.912Z'
+ created_at: '2026-03-16T21:06:20.713Z'
+ updated_at: '2026-03-16T21:06:20.713Z'
+ status: checkout
source_type:
source_id:
source:
@@ -6840,19 +7168,19 @@ paths:
example:
data:
- id: prod_UkLWZg9DAJ
- name: Product 597011
- description: |-
- Corrupti omnis nulla deserunt voluptatum reprehenderit. Quam ipsam autem deleniti recusandae cum. Corrupti quod molestias illo asperiores quas. Quibusdam provident nemo consectetur eius. Eius consectetur suscipit reprehenderit natus.
- Nobis expedita ex laudantium harum soluta itaque veniam. Cupiditate sed vero impedit incidunt sapiente deleniti. Nobis ullam nam distinctio odio pariatur hic. Impedit corporis nobis provident laboriosam.
- Dolorem et mollitia blanditiis dicta reprehenderit nostrum quidem quos. Illum aspernatur officia consectetur labore ipsum fugiat. Quia modi totam ad perferendis facere.
- Ut repudiandae voluptatibus natus maiores. Nesciunt dicta ut magni temporibus non. Assumenda tempore nesciunt modi consequuntur officiis. Perspiciatis fuga libero sed ipsa consequatur qui sequi praesentium. Molestiae tempora voluptatem iusto omnis inventore officia error.
- slug: product-597011
+ name: Product 629826
+ description: Provident nostrum esse consectetur hic. Commodi dolores
+ blanditiis magni delectus illo. Corrupti provident consequatur
+ laboriosam alias. Mollitia eveniet quidem incidunt nobis eius
+ delectus ipsa possimus. Ut iusto veniam quaerat mollitia soluta
+ quos.
+ slug: product-629826
meta_description:
meta_keywords:
variant_count: 1
- available_on: '2025-03-16T11:42:44.563Z'
- created_at: '2026-03-16T11:42:44.576Z'
- updated_at: '2026-03-16T11:42:44.615Z'
+ available_on: '2025-03-16T21:06:21.361Z'
+ created_at: '2026-03-16T21:06:21.377Z'
+ updated_at: '2026-03-16T21:06:21.418Z'
purchasable: true
in_stock: false
backorderable: true
@@ -6872,17 +7200,17 @@ paths:
price_list_id:
original_price:
- id: prod_gbHJdmfrXB
- name: Product 60113
+ name: Product 637492
description: |-
- Facere ullam exercitationem possimus voluptatem. Occaecati odio vero facilis velit quod laudantium fuga eligendi. Minus nesciunt sed corrupti placeat. Ipsum dolorem illum assumenda dolorum quia. Qui iure recusandae minima velit nemo quam libero.
- Accusamus facilis voluptate delectus doloremque ratione corrupti ex. Eum tempore officiis nam optio. Quam alias nostrum fugit facilis excepturi labore. Magnam maiores voluptatem iure aperiam in molestiae eum.
- slug: product-60113
+ Atque iusto quos voluptate sapiente deleniti totam nulla. Maxime neque itaque vel voluptatem quos provident aliquid perferendis. Cumque minima quod sed minus est earum repellendus. Neque molestias ut corrupti aperiam expedita nesciunt consequuntur quas. Fugiat quia labore rerum mollitia minima accusamus suscipit enim.
+ Rem dignissimos fuga consequuntur beatae cumque accusantium error quos. Eos architecto soluta sunt sequi autem et commodi non. Reiciendis id facilis voluptas voluptate quisquam dolores. Sint amet repudiandae ab maxime incidunt perferendis tenetur. Placeat sint corrupti cupiditate modi quasi dolorem ut.
+ slug: product-637492
meta_description:
meta_keywords:
variant_count: 0
- available_on: '2025-03-16T11:42:44.621Z'
- created_at: '2026-03-16T11:42:44.631Z'
- updated_at: '2026-03-16T11:42:44.644Z'
+ available_on: '2025-03-16T21:06:21.422Z'
+ created_at: '2026-03-16T21:06:21.431Z'
+ updated_at: '2026-03-16T21:06:21.442Z'
purchasable: true
in_stock: false
backorderable: true
@@ -6988,17 +7316,17 @@ paths:
application/json:
example:
id: prod_UkLWZg9DAJ
- name: Product 71220
- description: Blanditiis fuga nostrum expedita exercitationem labore.
- Incidunt qui neque quam dolores dignissimos cum nihil debitis. Eum
- deserunt cumque maxime exercitationem ipsa provident voluptatum.
- slug: product-71220
+ name: Product 741106
+ description: |-
+ Laudantium earum tempora repellendus quidem porro odit autem ducimus. Consectetur dolorem eveniet earum repellat magnam voluptas magni. Quam officiis eveniet soluta eligendi. Harum facere sit ut eum perspiciatis soluta. Facilis hic quia sunt exercitationem harum.
+ Iure harum nulla alias itaque. Dicta iure voluptatibus deserunt ipsam numquam. Possimus eaque exercitationem animi esse. Pariatur voluptatum neque quia reprehenderit velit earum nulla.
+ slug: product-741106
meta_description:
meta_keywords:
variant_count: 1
- available_on: '2025-03-16T11:42:45.169Z'
- created_at: '2026-03-16T11:42:45.185Z'
- updated_at: '2026-03-16T11:42:45.221Z'
+ available_on: '2025-03-16T21:06:22.010Z'
+ created_at: '2026-03-16T21:06:22.023Z'
+ updated_at: '2026-03-16T21:06:22.057Z'
purchasable: true
in_stock: false
backorderable: true
@@ -7092,389 +7420,76 @@ paths:
options:
- id: in_stock
count: 2
- - id: out_of_stock
- count: 0
- - id: opt_UkLWZg9DAJ
- type: option
- name: size
- presentation: Size
- options:
- - id: optval_UkLWZg9DAJ
- name: small
- presentation: S
- position: 1
- count: 1
- - id: categories
- type: category
- options:
- - id: ctg_EfhxLZ9ck8
- name: Shirts
- permalink: taxonomy-29/taxon-39/shirts
- count: 2
- sort_options:
- - id: manual
- - id: best_selling
- - id: price
- - id: "-price"
- - id: "-available_on"
- - id: available_on
- - id: name
- - id: "-name"
- default_sort: manual
- total_count: 2
- schema:
- type: object
- properties:
- filters:
- type: array
- description: Available filters (price_range, availability, option,
- category)
- items:
- type: object
- sort_options:
- type: array
- description: Available sort options
- items:
- type: object
- properties:
- id:
- type: string
- required:
- - id
- default_sort:
- type: string
- description: Default sort option ID
- total_count:
- type: integer
- description: Total products matching current filters
- required:
- - filters
- - sort_options
- - default_sort
- - total_count
- '401':
- description: unauthorized - invalid or missing API key
- content:
- application/json:
- example:
- error:
- code: invalid_token
- message: Valid API key required
- schema:
- "$ref": "#/components/schemas/ErrorResponse"
- "/api/v3/store/carts/{cart_id}/shipments":
- get:
- summary: List shipments
- tags:
- - Carts
- security:
- - api_key: []
- bearer_auth: []
- description: Returns all shipments with shipping rates for the cart.
- x-codeSamples:
- - lang: javascript
- label: Spree SDK
- source: |-
- import { createClient } from '@spree/sdk'
-
- const client = createClient({
- baseUrl: 'https://your-store.com',
- publishableKey: '<api-key>',
- })
-
- const shipments = await client.carts.shipments.list('cart_abc123', {
- bearerToken: '<token>',
- })
- parameters:
- - name: x-spree-api-key
- in: header
- required: true
- schema:
- type: string
- - name: Authorization
- in: header
- required: false
- schema:
- type: string
- - name: cart_id
- in: path
- required: true
- description: Cart prefixed ID (e.g., cart_abc123)
- schema:
- type: string
- - name: x-spree-token
- in: header
- required: false
- description: Order token for guest access
- schema:
- type: string
- responses:
- '200':
- description: shipments found
- content:
- application/json:
- example:
- data:
- - id: ship_UkLWZg9DAJ
- number: H32619135381
- state: pending
- tracking: U10000
- tracking_url:
- cost: '100.0'
- display_cost: "$100.00"
- shipped_at:
- created_at: '2026-03-16T11:42:47.061Z'
- updated_at: '2026-03-16T11:42:47.073Z'
- shipping_method:
- id: shpm_UkLWZg9DAJ
- name: UPS Ground
- code: UPS_GROUND
- stock_location:
- id: sloc_UkLWZg9DAJ
- state_abbr: STATE_ABBR_250
- name: Heidy Breitenberg
- address1: 1600 Pennsylvania Ave NW
- city: Washington
- zipcode: '20500'
- country_iso: US
- country_name: United States of America
- state_text: STATE_ABBR_250
- 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
- meta:
- count: 1
- "/api/v3/store/carts/{cart_id}/shipments/{id}":
- patch:
- summary: Select shipping rate for shipment
- tags:
- - Carts
- security:
- - api_key: []
- bearer_auth: []
- description: Selects a shipping rate for a specific shipment and auto-advances
- checkout.
- x-codeSamples:
- - lang: javascript
- label: Spree SDK
- source: |-
- import { createClient } from '@spree/sdk'
-
- const client = createClient({
- baseUrl: 'https://your-store.com',
- publishableKey: '<api-key>',
- })
-
- const cart = await client.carts.shipments.update('cart_abc123', 'ship_abc123', {
- selected_shipping_rate_id: 'shpr_abc123',
- }, {
- bearerToken: '<token>',
- })
- parameters:
- - name: x-spree-api-key
- in: header
- required: true
- schema:
- type: string
- - name: Authorization
- in: header
- required: false
- schema:
- type: string
- - name: cart_id
- in: path
- required: true
- description: Cart prefixed ID
- schema:
- type: string
- - name: id
- in: path
- required: true
- description: Shipment ID
- schema:
- type: string
- - name: x-spree-token
- in: header
- required: false
- description: Order token for guest access
- schema:
- type: string
- responses:
- '200':
- description: shipping rate selected, returns updated cart
- content:
- application/json:
- example:
- id: cart_UkLWZg9DAJ
- number: R706175501
- token: uS2yq6s6KK5KbJPuRRN8JDNmLLNzKcfyxk9
- special_instructions:
- currency: USD
- locale: en
- item_count: 1
- 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"
- created_at: '2026-03-16T11:42:47.633Z'
- updated_at: '2026-03-16T11:42:47.717Z'
- current_step: payment
- completed_steps:
- - address
- - delivery
- requirements:
- - step: payment
- field: payment
- message: Add a payment method
- promotions: []
- items:
- - id: li_UkLWZg9DAJ
- variant_id: variant_UkLWZg9DAJ
- quantity: 1
- currency: USD
- name: Product 1007033
- slug: product-1007033
- 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-16T11:42:47.662Z'
- updated_at: '2026-03-16T11:42:47.662Z'
- compare_at_amount:
- thumbnail_url:
- option_values: []
- digital_links: []
- shipments:
- - id: ship_UkLWZg9DAJ
- number: H01859618016
- state: pending
- tracking: U10000
- tracking_url:
- cost: '100.0'
- display_cost: "$100.00"
- shipped_at:
- created_at: '2026-03-16T11:42:47.667Z'
- updated_at: '2026-03-16T11:42:47.700Z'
- shipping_method:
- id: shpm_UkLWZg9DAJ
- name: UPS Ground
- code: UPS_GROUND
- stock_location:
- id: sloc_UkLWZg9DAJ
- state_abbr: STATE_ABBR_254
- name: Elyse Anderson
- address1: 1600 Pennsylvania Ave NW
- city: Washington
- zipcode: '20500'
- country_iso: US
- country_name: United States of America
- state_text: STATE_ABBR_254
- 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: 236 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_256
- state_abbr: STATE_ABBR_256
- quick_checkout: false
- state_name: STATE_NAME_256
- ship_address:
- id: addr_VqXmZF31wY
- firstname: John
- lastname: Doe
- full_name: John Doe
- address1: 237 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_257
- state_abbr: STATE_ABBR_257
- quick_checkout: false
- state_name: STATE_NAME_257
- payment_methods: []
+ - id: out_of_stock
+ count: 0
+ - id: opt_UkLWZg9DAJ
+ type: option
+ name: size
+ presentation: Size
+ options:
+ - id: optval_UkLWZg9DAJ
+ name: small
+ presentation: S
+ position: 1
+ count: 1
+ - id: categories
+ type: category
+ options:
+ - id: ctg_EfhxLZ9ck8
+ name: Shirts
+ permalink: taxonomy-29/taxon-39/shirts
+ count: 2
+ sort_options:
+ - id: manual
+ - id: best_selling
+ - id: price
+ - id: "-price"
+ - id: "-available_on"
+ - id: available_on
+ - id: name
+ - id: "-name"
+ default_sort: manual
+ total_count: 2
schema:
- "$ref": "#/components/schemas/Cart"
- '404':
- description: shipping rate not found
+ type: object
+ properties:
+ filters:
+ type: array
+ description: Available filters (price_range, availability, option,
+ category)
+ items:
+ type: object
+ sort_options:
+ type: array
+ description: Available sort options
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ required:
+ - id
+ default_sort:
+ type: string
+ description: Default sort option ID
+ total_count:
+ type: integer
+ description: Total products matching current filters
+ required:
+ - filters
+ - sort_options
+ - default_sort
+ - total_count
+ '401':
+ description: unauthorized - invalid or missing API key
content:
application/json:
example:
error:
- code: record_not_found
- message: Shipping rate not found
+ code: invalid_token
+ message: Valid API key required
schema:
"$ref": "#/components/schemas/ErrorResponse"
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- selected_shipping_rate_id:
- type: string
- example: shpr_abc123
- description: Shipping rate ID to select
- required:
- - selected_shipping_rate_id
"/api/v3/store/carts/{cart_id}/store_credits":
post:
summary: Apply store credit
@@ -7533,17 +7548,15 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R685095009
- token: t3PTz46C1e8c5zfHcuUbDvKMTGYVmFQFroG
+ number: R432761487
+ token: 9abfj5RfrHyhYta4s4jUkRxmjTVqNaarnjg
special_instructions:
currency: USD
locale: en
item_count: 1
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'
@@ -7556,8 +7569,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-16T11:42:48.865Z'
- updated_at: '2026-03-16T11:42:48.947Z'
+ created_at: '2026-03-16T21:06:23.976Z'
+ updated_at: '2026-03-16T21:06:24.026Z'
+ delivery_total: '100.0'
+ display_delivery_total: "$100.00"
current_step: address
completed_steps: []
requirements: []
@@ -7567,8 +7582,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 1023689
- slug: product-1023689
+ name: Product 1024978
+ slug: product-1024978
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -7587,58 +7602,59 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:48.915Z'
- updated_at: '2026-03-16T11:42:48.915Z'
+ created_at: '2026-03-16T21:06:24.006Z'
+ updated_at: '2026-03-16T21:06:24.006Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
- shipments:
- - id: ship_UkLWZg9DAJ
- number: H41244189674
- state: pending
+ fulfillments:
+ - id: ful_UkLWZg9DAJ
+ number: H54888989147
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- shipped_at:
- created_at: '2026-03-16T11:42:48.924Z'
- updated_at: '2026-03-16T11:42:48.943Z'
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ created_at: '2026-03-16T21:06:24.011Z'
+ updated_at: '2026-03-16T21:06:24.024Z'
+ status: pending
+ fulfillment_type: shipping
+ fulfilled_at:
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_262
- name: Forrest Legros
+ name: Julieann Jacobs
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
country_iso: US
country_name: United States of America
state_text: STATE_ABBR_262
- shipping_rates:
- - id: shpr_UkLWZg9DAJ
- shipping_method_id: shpm_UkLWZg9DAJ
+ delivery_rates:
+ - id: dr_UkLWZg9DAJ
+ delivery_method_id: dm_UkLWZg9DAJ
name: UPS Ground
selected: true
cost: '100.0'
display_cost: "$100.00"
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
payments:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- state: checkout
- response_code: 1-SC-20260316114249277866
- number: PD9CO5Q5
+ response_code: 1-SC-20260316210624331529
+ number: PPXNDO31
amount: '10.0'
display_amount: "$10.00"
- created_at: '2026-03-16T11:42:49.282Z'
- updated_at: '2026-03-16T11:42:49.282Z'
+ created_at: '2026-03-16T21:06:24.334Z'
+ updated_at: '2026-03-16T21:06:24.334Z'
+ status: checkout
source_type: store_credit
source_id: credit_UkLWZg9DAJ
source:
@@ -7769,17 +7785,15 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R556097630
- token: DNEdTx4FU6gYcifjJ2aH8MUPEMmays28g5g
+ number: R873206436
+ token: CUsfpp6AmczdiKhrwsjraB7aWqzhFR7GnEX
special_instructions:
currency: USD
locale: en
item_count: 1
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'
@@ -7792,8 +7806,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-16T11:42:50.441Z'
- updated_at: '2026-03-16T11:42:50.488Z'
+ created_at: '2026-03-16T21:06:25.679Z'
+ updated_at: '2026-03-16T21:06:25.735Z'
+ delivery_total: '100.0'
+ display_delivery_total: "$100.00"
current_step: address
completed_steps: []
requirements:
@@ -7806,8 +7822,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 1046044
- slug: product-1046044
+ name: Product 1046993
+ slug: product-1046993
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -7826,46 +7842,47 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-16T11:42:50.468Z'
- updated_at: '2026-03-16T11:42:50.468Z'
+ created_at: '2026-03-16T21:06:25.711Z'
+ updated_at: '2026-03-16T21:06:25.711Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
- shipments:
- - id: ship_UkLWZg9DAJ
- number: H07440904442
- state: pending
+ fulfillments:
+ - id: ful_UkLWZg9DAJ
+ number: H58646618682
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- shipped_at:
- created_at: '2026-03-16T11:42:50.472Z'
- updated_at: '2026-03-16T11:42:50.485Z'
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ created_at: '2026-03-16T21:06:25.717Z'
+ updated_at: '2026-03-16T21:06:25.732Z'
+ status: pending
+ fulfillment_type: shipping
+ fulfilled_at:
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_270
- name: Cherish Green
+ name: Maggie Kuphal
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
country_iso: US
country_name: United States of America
state_text: STATE_ABBR_270
- shipping_rates:
- - id: shpr_UkLWZg9DAJ
- shipping_method_id: shpm_UkLWZg9DAJ
+ delivery_rates:
+ - id: dr_UkLWZg9DAJ
+ delivery_method_id: dm_UkLWZg9DAJ
name: UPS Ground
selected: true
cost: '100.0'
display_cost: "$100.00"
- shipping_method:
- id: shpm_UkLWZg9DAJ
+ delivery_method:
+ id: dm_UkLWZg9DAJ
name: UPS Ground
code: UPS_GROUND
payments: []
@@ -7966,9 +7983,9 @@ paths:
data:
- id: wl_UkLWZg9DAJ
name: My Wishlist
- token: dkuvh484hiXe6uVHeTy74DgD
- created_at: '2026-03-16T11:42:51.049Z'
- updated_at: '2026-03-16T11:42:51.049Z'
+ token: 2MpQ6vrvQTKEBcaLasouL4xe
+ created_at: '2026-03-16T21:06:26.312Z'
+ updated_at: '2026-03-16T21:06:26.312Z'
is_default: false
is_private: true
meta:
@@ -8044,9 +8061,9 @@ paths:
example:
id: wl_gbHJdmfrXB
name: Birthday Ideas
- token: rezrFsX8j96FoJPxxN76T4fN
- created_at: '2026-03-16T11:42:52.221Z'
- updated_at: '2026-03-16T11:42:52.221Z'
+ token: VFNHKxVmrEsSxk4643HYKULY
+ created_at: '2026-03-16T21:06:27.545Z'
+ updated_at: '2026-03-16T21:06:27.545Z'
is_default: false
is_private: true
schema:
@@ -8142,9 +8159,9 @@ paths:
example:
id: wl_UkLWZg9DAJ
name: My Wishlist
- token: T3nvejJBwkEfb5gR57Lsc3Aw
- created_at: '2026-03-16T11:42:53.331Z'
- updated_at: '2026-03-16T11:42:53.331Z'
+ token: sAyZ3JXpCTx4dqH5VSu2oD9n
+ created_at: '2026-03-16T21:06:28.782Z'
+ updated_at: '2026-03-16T21:06:28.782Z'
is_default: false
is_private: true
schema:
@@ -8206,9 +8223,9 @@ paths:
example:
id: wl_UkLWZg9DAJ
name: Updated Name
- token: SLMiCNtkg26pgV693X6bQV7M
- created_at: '2026-03-16T11:42:54.465Z'
- updated_at: '2026-03-16T11:42:54.505Z'
+ token: EME5QY5t5KD1d867xdGnQsqx
+ created_at: '2026-03-16T21:06:29.930Z'
+ updated_at: '2026-03-16T21:06:29.970Z'
is_default: false
is_private: true
schema:
@@ -8320,18 +8337,17 @@ paths:
variant_id: variant_gbHJdmfrXB
wishlist_id: wl_UkLWZg9DAJ
quantity: 1
- created_at: '2026-03-16T11:42:55.669Z'
- updated_at: '2026-03-16T11:42:55.669Z'
+ created_at: '2026-03-16T21:06:31.140Z'
+ updated_at: '2026-03-16T21:06:31.140Z'
variant:
id: variant_gbHJdmfrXB
product_id: prod_gbHJdmfrXB
sku: SKU-124
- is_master: true
options_text: ''
track_inventory: true
media_count: 0
- created_at: '2026-03-16T11:42:55.641Z'
- updated_at: '2026-03-16T11:42:55.652Z'
+ created_at: '2026-03-16T21:06:31.105Z'
+ updated_at: '2026-03-16T21:06:31.121Z'
thumbnail_url:
purchasable: true
in_stock: false
@@ -8758,10 +8774,6 @@ components:
type: string
display_item_total:
type: string
- ship_total:
- type: string
- display_ship_total:
- type: string
adjustment_total:
type: string
display_adjustment_total:
@@ -8790,6 +8802,10 @@ components:
type: string
updated_at:
type: string
+ delivery_total:
+ type: string
+ display_delivery_total:
+ type: string
current_step:
type: string
completed_steps:
@@ -8808,10 +8824,10 @@ components:
type: array
items:
"$ref": "#/components/schemas/LineItem"
- shipments:
+ fulfillments:
type: array
items:
- "$ref": "#/components/schemas/Shipment"
+ "$ref": "#/components/schemas/Fulfillment"
payments:
type: array
items:
@@ -8839,8 +8855,6 @@ components:
- item_count
- item_total
- display_item_total
- - ship_total
- - display_ship_total
- adjustment_total
- display_adjustment_total
- promo_total
@@ -8855,12 +8869,14 @@ components:
- display_total
- created_at
- updated_at
+ - delivery_total
+ - display_delivery_total
- current_step
- completed_steps
- requirements
- promotions
- items
- - shipments
+ - fulfillments
- payments
- bill_address
- ship_address
@@ -9089,6 +9105,47 @@ components:
- default_billing_address
- default_shipping_address
x-typelizer: true
+ DeliveryMethod:
+ type: object
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ code:
+ type: string
+ nullable: true
+ required:
+ - id
+ - name
+ - code
+ x-typelizer: true
+ DeliveryRate:
+ type: object
+ properties:
+ id:
+ type: string
+ delivery_method_id:
+ type: string
+ name:
+ type: string
+ selected:
+ type: boolean
+ cost:
+ type: string
+ display_cost:
+ type: string
+ delivery_method:
+ "$ref": "#/components/schemas/DeliveryMethod"
+ required:
+ - id
+ - delivery_method_id
+ - name
+ - selected
+ - cost
+ - display_cost
+ - delivery_method
+ x-typelizer: true
DigitalLink:
type: object
properties:
@@ -9171,6 +9228,58 @@ components:
- updated_at
- user_id
x-typelizer: true
+ Fulfillment:
+ type: object
+ properties:
+ id:
+ type: string
+ number:
+ type: string
+ tracking:
+ type: string
+ nullable: true
+ tracking_url:
+ type: string
+ nullable: true
+ cost:
+ type: string
+ display_cost:
+ type: string
+ created_at:
+ type: string
+ updated_at:
+ type: string
+ status:
+ type: string
+ fulfillment_type:
+ type: string
+ fulfilled_at:
+ type: string
+ nullable: true
+ delivery_method:
+ "$ref": "#/components/schemas/DeliveryMethod"
+ stock_location:
+ "$ref": "#/components/schemas/StockLocation"
+ delivery_rates:
+ type: array
+ items:
+ "$ref": "#/components/schemas/DeliveryRate"
+ required:
+ - id
+ - number
+ - tracking
+ - tracking_url
+ - cost
+ - display_cost
+ - created_at
+ - updated_at
+ - status
+ - fulfillment_type
+ - fulfilled_at
+ - delivery_method
+ - stock_location
+ - delivery_rates
+ x-typelizer: true
GiftCardBatch:
type: object
properties:
@@ -9215,7 +9324,7 @@ components:
type: string
code:
type: string
- state:
+ status:
type: string
currency:
type: string
@@ -9250,7 +9359,7 @@ components:
required:
- id
- code
- - state
+ - status
- currency
- amount
- amount_used
@@ -9650,7 +9759,7 @@ components:
verified_at:
type: string
nullable: true
- user_id:
+ customer_id:
type: string
nullable: true
required:
@@ -9660,7 +9769,7 @@ components:
- updated_at
- verified
- verified_at
- - user_id
+ - customer_id
x-typelizer: true
OptionType:
type: object
@@ -9752,20 +9861,10 @@ components:
nullable: true
item_count:
type: number
- shipment_state:
- type: string
- nullable: true
- payment_state:
- type: string
- nullable: true
item_total:
type: string
display_item_total:
type: string
- ship_total:
- type: string
- display_ship_total:
- type: string
adjustment_total:
type: string
display_adjustment_total:
@@ -9797,6 +9896,16 @@ components:
type: string
updated_at:
type: string
+ fulfillment_status:
+ type: string
+ nullable: true
+ payment_status:
+ type: string
+ nullable: true
+ delivery_total:
+ type: string
+ display_delivery_total:
+ type: string
promotions:
type: array
items:
@@ -9805,10 +9914,10 @@ components:
type: array
items:
"$ref": "#/components/schemas/LineItem"
- shipments:
+ fulfillments:
type: array
items:
- "$ref": "#/components/schemas/Shipment"
+ "$ref": "#/components/schemas/Fulfillment"
payments:
type: array
items:
@@ -9829,12 +9938,8 @@ components:
- currency
- locale
- item_count
- - shipment_state
- - payment_state
- item_total
- display_item_total
- - ship_total
- - display_ship_total
- adjustment_total
- display_adjustment_total
- promo_total
@@ -9850,9 +9955,13 @@ components:
- completed_at
- created_at
- updated_at
+ - fulfillment_status
+ - payment_status
+ - delivery_total
+ - display_delivery_total
- promotions
- items
- - shipments
+ - fulfillments
- payments
- bill_address
- ship_address
@@ -9885,8 +9994,6 @@ components:
type: string
payment_method_id:
type: string
- state:
- type: string
response_code:
type: string
nullable: true
@@ -9900,6 +10007,8 @@ components:
type: string
updated_at:
type: string
+ status:
+ type: string
source_type:
type: string
nullable: true
@@ -9921,13 +10030,13 @@ components:
required:
- id
- payment_method_id
- - state
- response_code
- number
- amount
- display_amount
- created_at
- updated_at
+ - status
- source_type
- source_id
- source
@@ -10142,8 +10251,6 @@ components:
"$ref": "#/components/schemas/Variant"
default_variant:
"$ref": "#/components/schemas/Variant"
- master_variant:
- "$ref": "#/components/schemas/Variant"
option_types:
type: array
items:
@@ -10435,55 +10542,6 @@ components:
- reimbursement_id
- exchange_variant_id
x-typelizer: true
- Shipment:
- type: object
- properties:
- id:
- type: string
- number:
- type: string
- state:
- type: string
- tracking:
- type: string
- nullable: true
- tracking_url:
- type: string
- nullable: true
- cost:
- type: string
- display_cost:
- type: string
- shipped_at:
- type: string
- nullable: true
- created_at:
- type: string
- updated_at:
- type: string
- shipping_method:
- "$ref": "#/components/schemas/ShippingMethod"
- stock_location:
- "$ref": "#/components/schemas/StockLocation"
- shipping_rates:
- type: array
- items:
- "$ref": "#/components/schemas/ShippingRate"
- required:
- - id
- - number
- - state
- - tracking
- - tracking_url
- - cost
- - display_cost
- - shipped_at
- - created_at
- - updated_at
- - shipping_method
- - stock_location
- - shipping_rates
- x-typelizer: true
ShippingCategory:
type: object
properties:
@@ -10495,47 +10553,6 @@ components:
- id
- name
x-typelizer: true
- ShippingMethod:
- type: object
- properties:
- id:
- type: string
- name:
- type: string
- code:
- type: string
- nullable: true
- required:
- - id
- - name
- - code
- x-typelizer: true
- ShippingRate:
- type: object
- properties:
- id:
- type: string
- shipping_method_id:
- type: string
- name:
- type: string
- selected:
- type: boolean
- cost:
- type: string
- display_cost:
- type: string
- shipping_method:
- "$ref": "#/components/schemas/ShippingMethod"
- required:
- - id
- - shipping_method_id
- - name
- - selected
- - cost
- - display_cost
- - shipping_method
- x-typelizer: true
State:
type: object
properties:
@@ -10731,8 +10748,6 @@ components:
sku:
type: string
nullable: true
- is_master:
- type: boolean
options_text:
type: string
track_inventory:
@@ -10788,7 +10803,6 @@ components:
- id
- product_id
- sku
- - is_master
- options_text
- track_inventory
- media_count
diff --git a/docs/developer/sdk/configuration.mdx b/docs/developer/sdk/configuration.mdx
index 5d406ad194..fcc88c4e08 100644
--- a/docs/developer/sdk/configuration.mdx
+++ b/docs/developer/sdk/configuration.mdx
@@ -62,7 +62,7 @@ const order = await client.orders.get('or_abc123', {}, { token });
// Monetary fields are strings
order.total; // "129.99"
order.item_total; // "99.99"
-order.ship_total; // "10.00"
+order.delivery_total; // "10.00"
order.tax_total; // "20.00"
// Display fields include currency formatting
@@ -72,7 +72,7 @@ order.display_total; // "$129.99"
const total = parseFloat(order.total);
```
-This applies to all monetary fields across all types: `StoreOrder`, `StoreLineItem`, `StoreShipment`, `StorePayment`, `StoreGiftCard`, `StorePrice`, etc.
+This applies to all monetary fields across all types: `Order`, `LineItem`, `Fulfillment`, `Payment`, `GiftCard`, `Price`, etc.
## TypeScript Support
@@ -80,68 +80,79 @@ The SDK includes full TypeScript support with generated types from the API seria
```typescript
import type {
- StoreProduct,
- StoreOrder,
- StoreVariant,
- StoreCategory,
- StoreLineItem,
- StoreAddress,
- StoreCustomer,
+ Product,
+ Order,
+ Cart,
+ Variant,
+ Category,
+ LineItem,
+ Address,
+ Customer,
PaginatedResponse,
} from '@spree/sdk';
// All responses are fully typed
-const products: PaginatedResponse<StoreProduct> = await client.products.list();
-const category: StoreCategory = await client.categories.get('clothing');
+const products: PaginatedResponse<Product> = await client.products.list();
+const category: Category = await client.categories.get('clothing');
```
## Available Types
+All types are exported as unprefixed names (e.g., `Product`, `Order`). Legacy `Store*` prefixed aliases (e.g., `StoreProduct`) are still available for backward compatibility.
+
### Core Types
-- `StoreProduct` - Product data
-- `StoreVariant` - Variant data
-- `StoreOrder` - Order/cart data
-- `StoreLineItem` - Line item in cart
-- `StoreCategory` - Category
-- `StoreCountry` - Country with states
-- `StoreState` - State/province
-- `StoreAddress` - Customer address
-- `StoreCustomer` - Customer profile
+- `Product` - Product data
+- `Variant` - Variant data
+- `Cart` - Cart data (uses `cart_` prefixed IDs)
+- `Order` - Completed order data (uses `or_` prefixed IDs)
+- `LineItem` - Line item in cart
+- `Category` - Category
+- `Country` - Country with states
+- `State` - State/province
+- `Address` - Customer address
+- `Customer` - Customer profile
+- `Market` - Market configuration (currency, locales, countries)
### Commerce Types
-- `StorePayment` - Payment record
-- `StorePaymentMethod` - Payment method
-- `StorePaymentSession` - Provider-agnostic payment session
-- `StoreShipment` - Shipment record
-- `StoreShippingRate` - Shipping rate option
-- `StoreShippingMethod` - Shipping method
-- `StoreCreditCard` - Saved credit card
-- `StoreGiftCard` - Gift card
+- `Payment` - Payment record
+- `PaymentMethod` - Payment method
+- `PaymentSession` - Provider-agnostic payment session
+- `Fulfillment` - Fulfillment record
+- `DeliveryRate` - Delivery rate option
+- `DeliveryMethod` - Delivery method
+- `CreditCard` - Saved credit card
+- `GiftCard` - Gift card
+- `CartPromotion` - Promotion applied to a cart
+- `OrderPromotion` - Promotion applied to an order
### Product Types
-- `StoreImage` - Product image
-- `StorePrice` - Price data
-- `StoreOptionType` - Option type (e.g., Size, Color)
-- `StoreOptionValue` - Option value (e.g., Small, Red)
-- `StoreDigitalLink` - Digital download link
+- `Media` - Product media (images, videos)
+- `Price` - Price data
+- `OptionType` - Option type (e.g., Size, Color)
+- `OptionValue` - Option value (e.g., Small, Red)
+- `DigitalLink` - Digital download link
+- `Metafield` - Custom metafield data
### Wishlist Types
-- `StoreWishlist` - Wishlist
-- `StoreWishedItem` - Wishlist item
+- `Wishlist` - Wishlist
+- `WishedItem` - Wishlist item
### Client Types
-- `SpreeClient` - Main client class
-- `StoreClient` - Store API client
-- `AdminClient` - Admin API client
-- `SpreeClientConfig` - Client configuration
+- `Client` - Main client interface
+- `StoreClient` - Store API client class
+- `ClientConfig` - Client configuration
- `RequestOptions` - Per-request options
- `RetryConfig` - Retry behavior configuration
### Utility Types
- `PaginatedResponse<T>` - Paginated API response
+- `ListResponse<T>` - List API response
- `AuthTokens` - JWT tokens from login
- `AddressParams` - Address input parameters
+- `UpdateCartParams` - Cart update parameters
+- `CreatePaymentParams` - Direct payment creation parameters
- `CreatePaymentSessionParams` - Payment session creation parameters
- `UpdatePaymentSessionParams` - Payment session update parameters
- `CompletePaymentSessionParams` - Payment session completion parameters
- `ProductFiltersResponse` - Product filters response
+- `CheckoutRequirement` - Checkout requirement (`{ step, field, message }`)
diff --git a/docs/developer/sdk/quickstart.mdx b/docs/developer/sdk/quickstart.mdx
index 586995f7c9..70f622d52e 100644
--- a/docs/developer/sdk/quickstart.mdx
+++ b/docs/developer/sdk/quickstart.mdx
@@ -60,7 +60,7 @@ The SDK uses a resource builder pattern for nested resources:
| `carts` | `payments` | `list`, `get`, `create` |
| `carts` | `paymentMethods` | `list` |
| `carts` | `paymentSessions` | `create`, `get`, `update`, `complete` |
-| `carts` | `shipments` | `list`, `update` |
+| `carts` | `fulfillments` | `list`, `update` |
| `carts` | `couponCodes` | `apply`, `remove` |
| `carts` | `storeCredits` | `apply`, `remove` |
| `customer` | `addresses` | `list`, `get`, `create`, `update`, `delete`, `markAsDefault` |
@@ -75,7 +75,7 @@ The SDK uses a resource builder pattern for nested resources:
// Nested resources follow the pattern: client.parent.nested.method(parentId, ...)
await client.carts.items.create(cartId, params, options);
await client.carts.payments.list(cartId, options);
-await client.carts.shipments.update(cartId, shipmentId, params, options);
+await client.carts.fulfillments.update(cartId, fulfillmentId, params, options);
await client.customer.addresses.list({}, options);
await client.categories.products.list(categoryId, params, options);
await client.wishlists.items.create(wishlistId, params, options);
diff --git a/docs/developer/sdk/store/cart-checkout.mdx b/docs/developer/sdk/store/cart-checkout.mdx
index a98f4b5583..b7e1e24b89 100644
--- a/docs/developer/sdk/store/cart-checkout.mdx
+++ b/docs/developer/sdk/store/cart-checkout.mdx
@@ -5,7 +5,7 @@ description: Manage carts, line items, coupons, checkout flow, and completed ord
The Store API is split into two resource groups:
-- **Carts** — managing shopping carts, items, coupon codes, checkout flow (addresses, shipping, payments, completion)
+- **Carts** — managing shopping carts, items, coupon codes, checkout flow (addresses, delivery, payments, completion)
- **Orders** — retrieving completed orders
All cart and checkout endpoints require a `cartId` as the first argument.
@@ -94,17 +94,17 @@ await client.carts.update(cartId, {
await client.carts.complete(cartId, { spreeToken: cart.token });
```
-### Shipments
+### Fulfillments
```typescript
const options = { spreeToken: cart.token };
-// List shipments
-const shipments = await client.carts.shipments.list(cartId, options);
+// List fulfillments
+const fulfillments = await client.carts.fulfillments.list(cartId, options);
-// Select a shipping rate
-await client.carts.shipments.update(cartId, shipmentId, {
- selected_shipping_rate_id: 'rate_xxx',
+// Select a delivery rate
+await client.carts.fulfillments.update(cartId, fulfillmentId, {
+ selected_delivery_rate_id: 'rate_xxx',
}, options);
```
@@ -129,7 +129,7 @@ await client.carts.storeCredits.remove(cartId, options);
```typescript
const order = await client.orders.get('R123456789', {
- expand: ['items', 'shipments'],
+ expand: ['items', 'fulfillments'],
}, { spreeToken: cart.token });
```
diff --git a/docs/developer/sdk/store/payments.mdx b/docs/developer/sdk/store/payments.mdx
index 5d84cebf2b..0fecd5d4ae 100644
--- a/docs/developer/sdk/store/payments.mdx
+++ b/docs/developer/sdk/store/payments.mdx
@@ -1,9 +1,9 @@
---
-title: Payments & Shipping
-description: Handle payments, payment sessions, and shipping with the Spree SDK
+title: Payments & Delivery
+description: Handle payments, payment sessions, and delivery with the Spree SDK
---
-All payment and shipping endpoints require a `cartId` as the first argument.
+All payment and delivery endpoints require a `cartId` as the first argument.
## Payment Methods
@@ -83,16 +83,16 @@ const completed = await client.carts.paymentSessions.complete(
console.log(completed.status); // 'completed'
```
-## Shipments
+## Fulfillments
```typescript
const options = { spreeToken: cart.token };
-// List shipments for the current cart
-const shipments = await client.carts.shipments.list(cartId, options);
+// List fulfillments for the current cart
+const fulfillments = await client.carts.fulfillments.list(cartId, options);
-// Select a shipping rate
-await client.carts.shipments.update(cartId, shipmentId, {
- selected_shipping_rate_id: 'rate_xxx',
+// Select a delivery rate
+await client.carts.fulfillments.update(cartId, fulfillmentId, {
+ selected_delivery_rate_id: 'rate_xxx',
}, options);
```
diff --git a/docs/developer/storefront/nextjs/quickstart.mdx b/docs/developer/storefront/nextjs/quickstart.mdx
index 61a68e0a8e..45dc0602bc 100644
--- a/docs/developer/storefront/nextjs/quickstart.mdx
+++ b/docs/developer/storefront/nextjs/quickstart.mdx
@@ -21,7 +21,7 @@ The [Spree Storefront](https://github.com/spree/storefront) is a production-read
- **Secure Authentication** - JWT tokens stored in httpOnly cookies
- **Product Catalog** - Browse, search, and filter with faceted navigation
- **Shopping Cart** - Server-side state management
-- **Multi-Step Checkout** - Guest and signed-in users, multi-shipments, coupon codes, gift cards, store credit
+- **Multi-Step Checkout** - Guest and signed-in users, multi-fulfillment, coupon codes, gift cards, store credit
- **Stripe Payments** - Credit Cards, Apple Pay, Google Pay, Klarna, Affirm, SEPA and more via [Spree Stripe](https://github.com/spree/spree_stripe)
- **Google Tag Manager** and **GA4 Ecommerce** event tracking
- **Customer Account** - Profile, order history, address book, gift cards, saved payment methods
diff --git a/docs/developer/storefront/nextjs/spree-next-package.mdx b/docs/developer/storefront/nextjs/spree-next-package.mdx
index b9c6384c20..2b5767b870 100644
--- a/docs/developer/storefront/nextjs/spree-next-package.mdx
+++ b/docs/developer/storefront/nextjs/spree-next-package.mdx
@@ -120,8 +120,8 @@ Checkout functions use the implicit cart resolved from cookies. No `orderId` is
import {
getCheckout,
updateCheckout,
- getShipments,
- selectShippingRate,
+ getFulfillments,
+ selectDeliveryRate,
applyCoupon,
removeCoupon,
complete,
@@ -129,8 +129,8 @@ import {
const checkout = await getCheckout();
await updateCheckout({ ship_address: { ... }, bill_address: { ... } });
-const shipments = await getShipments();
-await selectShippingRate(shipmentId, shippingRateId);
+const fulfillments = await getFulfillments();
+await selectDeliveryRate(fulfillmentId, deliveryRateId);
await applyCoupon('SAVE20');
await removeCoupon(promotionId);
await complete();
@@ -301,8 +301,8 @@ import type {
StoreCustomer,
StoreCreditCard,
StoreGiftCard,
- StoreShipment,
- StoreShippingRate,
+ StoreFulfillment,
+ StoreDeliveryRate,
StorePayment,
StorePaymentMethod,
StorePaymentSession,
diff --git a/docs/plans/5.x-store-api-bridges.md b/docs/plans/5.x-store-api-bridges.md
index 739f65d640..2612c40021 100644
--- a/docs/plans/5.x-store-api-bridges.md
+++ b/docs/plans/5.x-store-api-bridges.md
@@ -1,10 +1,10 @@
# Store API 5.x Bridges for 6.0
-**Status:** Design finalized, implementation not started
+**Status:** Implemented (PR #13782)
**Target:** Spree 5.5 (next minor)
**Depends on:** None — all changes are serializer/controller renames on existing models
**Author:** Damian + Claude
-**Last updated:** 2026-03-16
+**Last updated:** 2026-03-17
## Summary
@@ -156,57 +156,83 @@ The model split (Adjustment → TaxLine, Discount, Fee) happens in 6.0. But the
The Store API already uses `categories` naming. No serializer changes needed. The `Classification` model rename is internal.
-## Migration Checklist
-
-### File renames (5.5)
-
-```
-# Serializers
-shipment_serializer.rb → fulfillment_serializer.rb
-shipping_method_serializer.rb → delivery_method_serializer.rb
-shipping_rate_serializer.rb → delivery_rate_serializer.rb
-media_serializer.rb — already done in 5.4 ✓
-
-# Controllers
-carts/shipments_controller.rb → carts/fulfillments_controller.rb
-
-# Serializer field changes (no file rename, just content)
-cart_serializer.rb — rename nested keys (fulfillments, delivery_total)
-order_serializer.rb — rename fields (fulfillment_status, payment_status, delivery_total)
-product_serializer.rb — remove master_variant expand
-variant_serializer.rb — remove is_master
-payment_serializer.rb — state → status
-gift_card_serializer.rb — state → status
-```
-
-### Route renames (5.5)
-
-```
-/carts/:id/shipments → /carts/:id/fulfillments
-```
-
-### SDK type renames (5.5)
-
-```
-StoreShipment → StoreFulfillment
-StoreShippingMethod → StoreDeliveryMethod
-StoreShippingRate → StoreDeliveryRate
-StoreVariant.is_master → removed
-StoreOrder.shipment_state → StoreOrder.fulfillment_status
-StoreOrder.payment_state → StoreOrder.payment_status
-StoreOrder.ship_total → StoreOrder.delivery_total
-```
-
-### Pipeline after changes
-
-```bash
-cd spree/api && bundle exec rake typelizer:generate # regenerate TS types
-cd packages/sdk && pnpm generate:zod # regenerate Zod schemas
-cd spree/api && bundle exec rspec spec/integration/ # integration tests
-bundle exec rake rswag:specs:swaggerize # OpenAPI spec
-cd packages/sdk && pnpm test # SDK tests
-cd packages/next && pnpm test # Next.js tests
-```
+## Implementation Status
+
+All changes implemented in PR #13782. Versions bumped to 0.12.0 for both `@spree/sdk` and `@spree/next`.
+
+### Files created
+- `api/app/serializers/spree/api/v3/fulfillment_serializer.rb` ✓
+- `api/app/serializers/spree/api/v3/delivery_method_serializer.rb` ✓
+- `api/app/serializers/spree/api/v3/delivery_rate_serializer.rb` ✓
+- `api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb` ✓
+- `api/app/serializers/spree/api/v3/admin/delivery_method_serializer.rb` ✓
+- `api/app/serializers/spree/api/v3/admin/delivery_rate_serializer.rb` ✓
+- `api/app/controllers/spree/api/v3/store/carts/fulfillments_controller.rb` ✓
+- `api/spec/controllers/spree/api/v3/store/carts/fulfillments_controller_spec.rb` ✓
+- `api/spec/integration/spree/api/v3/store/fulfillments_spec.rb` ✓
+
+### Files deleted
+- `api/app/serializers/spree/api/v3/shipment_serializer.rb` ✓
+- `api/app/serializers/spree/api/v3/shipping_method_serializer.rb` ✓
+- `api/app/serializers/spree/api/v3/shipping_rate_serializer.rb` ✓
+- `api/app/serializers/spree/api/v3/admin/shipment_serializer.rb` ✓
+- `api/app/serializers/spree/api/v3/admin/shipping_method_serializer.rb` ✓
+- `api/app/serializers/spree/api/v3/admin/shipping_rate_serializer.rb` ✓
+- `api/app/controllers/spree/api/v3/store/carts/shipments_controller.rb` ✓
+- `api/spec/controllers/spree/api/v3/store/carts/shipments_controller_spec.rb` ✓
+- `api/spec/integration/spree/api/v3/store/shipments_spec.rb` ✓
+
+### Files modified
+- `cart_serializer.rb` — `ship_total` → `delivery_total`, `shipments` → `fulfillments` ✓
+- `order_serializer.rb` — `shipment_state` → `fulfillment_status`, `payment_state` → `payment_status`, `ship_total` → `delivery_total`, `shipments` → `fulfillments` ✓
+- `admin/order_serializer.rb` — `shipments` → `fulfillments`, `user_id` → `customer_id`, `expand=user` → `expand=customer` ✓
+- `admin/address_serializer.rb` — `user_id` → `customer_id` ✓
+- `admin/store_credit_serializer.rb` — `user_id` → `customer_id` ✓
+- `admin/credit_card_serializer.rb` — `user_id` → `customer_id` ✓
+- `newsletter_subscriber_serializer.rb` — `user_id` → `customer_id` ✓
+- `product_serializer.rb` — removed `expand=master_variant` ✓
+- `admin/product_serializer.rb` — removed `expand=master_variant` ✓
+- `variant_serializer.rb` — removed `is_master` ✓
+- `payment_serializer.rb` — `state` → `status` ✓
+- `gift_card_serializer.rb` — `state` → `status` ✓
+- `routes.rb` — `/shipments` → `/fulfillments` ✓
+- `dependencies.rb` — added new serializer registrations, pointed old keys to new classes ✓
+- `core/app/models/spree/shipment.rb` — prefix `ship` → `ful` ✓
+- `core/app/models/spree/shipping_method.rb` — prefix `shpm` → `dm` ✓
+- `core/app/models/spree/shipping_rate.rb` — prefix `shpr` → `dr` ✓
+- `core/app/models/spree/inventory_unit.rb` — prefix `iu` → `fi` ✓
+
+### Auto-generated (regenerated)
+- `packages/sdk/src/types/generated/` — all TS types ✓
+- `packages/sdk/src/zod/generated/` — all Zod schemas ✓
+- `packages/admin-sdk/src/types/generated/` — all admin TS types ✓
+- `docs/api-reference/store.yaml` — OpenAPI spec ✓
+
+### SDK/Next packages
+- `packages/sdk/src/store-client.ts` — `shipments` → `fulfillments` ✓
+- `packages/sdk/src/types/index.ts` — type re-exports updated ✓
+- `packages/sdk/tests/` — tests + mocks updated ✓
+- `packages/next/src/actions/cart.ts` — `getShipments` → `getFulfillments`, `selectShippingRate` → `selectDeliveryRate` ✓
+- `packages/next/src/index.ts` — re-exports updated ✓
+- `packages/next/tests/` — tests updated ✓
+- Both packages bumped to 0.12.0 with changesets ✓
+
+### Docs updated
+- `packages/sdk/README.md` ✓
+- `packages/next/README.md` ✓
+- `docs/developer/sdk/store/cart-checkout.mdx` ✓
+- `docs/developer/sdk/quickstart.mdx` ✓
+- `docs/developer/sdk/store/payments.mdx` ✓
+- `docs/developer/sdk/configuration.mdx` ✓
+- `docs/developer/storefront/nextjs/spree-next-package.mdx` ✓
+- `docs/developer/storefront/nextjs/quickstart.mdx` ✓
+
+### Test results
+- Backend integration tests: 149/149 pass ✓
+- SDK tests: 140/140 pass ✓
+- Next.js tests: 71/71 pass ✓
+- TypeScript typecheck: all packages pass ✓
+- Admin controller/feature specs: pass ✓
## What stays unchanged (bridges already done or not needed)
@@ -218,6 +244,23 @@ cd packages/next && pnpm test # Next.js tests
| `default_variant_id` on products | Already exists ✓ |
| ProductType, Collections, Stock Reservations, Returns/Claims, Channels/Catalogs | Purely additive — ship with 6.0 |
+## Prefixed IDs — changed in 5.x
+
+Prefixed IDs are updated to match the new vocabulary. The `find_by_prefix_id!` method ignores the prefix during decoding (it splits on `_` and decodes only the Sqids portion), so old IDs with old prefixes still resolve correctly.
+
+| Model | Old prefix | New prefix |
+|---|---|---|
+| Shipment | `ship_` | `ful_` |
+| ShippingMethod | `shpm_` | `dm_` |
+| ShippingRate | `shpr_` | `dr_` |
+| InventoryUnit | `iu_` | `fi_` |
+
+## NOT changed in 5.x (deferred to 6.0 model rename)
+
+### Event names
+
+Event names (`shipment.shipped`, `shipment.canceled`) are **not changed** in 5.x. Webhook subscribers and event listeners depend on these strings. They change in 6.0 to `fulfillment.fulfilled`, `fulfillment.canceled` with old names emitted alongside for one release.
+
## Constraints on Current Work
- **All new Store API code must use the 5.5 naming.** No `shipment`, `shipping_method`, `state`, `master_variant` in new endpoints.
diff --git a/docs/plans/6.0-fulfillment-and-delivery.md b/docs/plans/6.0-fulfillment-and-delivery.md
index 2dd8b4e0a6..94d138dae4 100644
--- a/docs/plans/6.0-fulfillment-and-delivery.md
+++ b/docs/plans/6.0-fulfillment-and-delivery.md
@@ -460,28 +460,28 @@ end
### Phase 2: Data migration (rake task)
```ruby
-# rake spree:migrate_shipping_to_delivery
-#
-# 1. Set fulfillment_type on delivery methods:
-# - Methods with DigitalDelivery calculator → fulfillment_type: 'digital',
-# fulfillment_provider: 'Spree::FulfillmentProvider::Digital'
-# - All others → fulfillment_type: 'shipping' (default)
-#
-# 2. Copy fulfillment_type to existing fulfillments from their selected delivery method
-#
-# 3. Migrate ShippingCategory → ProductType.fulfillment_types:
-# - Products with "Digital" ShippingCategory → ensure ProductType with fulfillment_types: ['digital']
-# - Products with other ShippingCategories → fulfillment_types: ['shipping']
-# - Remove shipping_category_id from products
-#
-# 4. Migrate store scoping:
-# - For each StoreShippingMethod join, set delivery_method.store_id = store_id
-# - Methods linked to multiple stores: duplicate the record (one per store)
-# - Drop spree_store_shipping_methods join table
-#
-# 5. Drop spree_shipping_categories and spree_shipping_method_categories tables
+rake spree:migrate_shipping_to_delivery
```
+1. Set fulfillment_type on delivery methods:
+ - Methods with DigitalDelivery calculator → fulfillment_type: 'digital',
+ fulfillment_provider: 'Spree::FulfillmentProvider::Digital'
+ - All others → fulfillment_type: 'shipping' (default)
+
+2. Copy fulfillment_type to existing fulfillments from their selected delivery method
+
+3. Migrate ShippingCategory → ProductType.fulfillment_types:
+ - Products with "Digital" ShippingCategory → ensure ProductType with fulfillment_types: ['digital']
+ - Products with other ShippingCategories → fulfillment_types: ['shipping']
+ - Remove shipping_category_id from products
+
+4. Migrate store scoping:
+ - For each StoreShippingMethod join, set delivery_method.store_id = store_id
+ - Methods linked to multiple stores: duplicate the record (one per store)
+ - Drop spree_store_shipping_methods join table
+
+5. Drop spree_shipping_categories and spree_shipping_method_categories tables
+
### Phase 3: Model renames + deprecation aliases
- All model files renamed
diff --git a/packages/admin-sdk/src/types/generated/Address.ts b/packages/admin-sdk/src/types/generated/Address.ts
index 0b71ac85ff..47b4837460 100644
--- a/packages/admin-sdk/src/types/generated/Address.ts
+++ b/packages/admin-sdk/src/types/generated/Address.ts
@@ -1,4 +1,4 @@
-// Typelizer digest cc9c88f5c0c47edebeedf1a72263d3ff
+// Typelizer digest 41755edff3c7f43176d1a4755677a9e4
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -22,7 +22,7 @@ type Address = {
label: string | null;
created_at: string;
updated_at: string;
- user_id: string | null;
+ customer_id: string | null;
metadata: Record<string, unknown> | null;
}
diff --git a/packages/admin-sdk/src/types/generated/CreditCard.ts b/packages/admin-sdk/src/types/generated/CreditCard.ts
index 55195416e4..08d13b182d 100644
--- a/packages/admin-sdk/src/types/generated/CreditCard.ts
+++ b/packages/admin-sdk/src/types/generated/CreditCard.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 6c4376c456a20d49b15563641ca3b8b6
+// Typelizer digest e3c2906b962aa5abebff3b826af5700f
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -11,7 +11,7 @@ type CreditCard = {
name: string | null;
default: boolean;
gateway_payment_profile_id: string | null;
- user_id: string | null;
+ customer_id: string | null;
payment_method_id: string | null;
created_at: string;
updated_at: string;
diff --git a/packages/admin-sdk/src/types/generated/ShippingMethod.ts b/packages/admin-sdk/src/types/generated/DeliveryMethod.ts
similarity index 61%
rename from packages/admin-sdk/src/types/generated/ShippingMethod.ts
rename to packages/admin-sdk/src/types/generated/DeliveryMethod.ts
index 4b2424bcc7..904c0bc9ec 100644
--- a/packages/admin-sdk/src/types/generated/ShippingMethod.ts
+++ b/packages/admin-sdk/src/types/generated/DeliveryMethod.ts
@@ -1,8 +1,8 @@
-// Typelizer digest 7e87662088622c2b2066e538cecb0564
+// Typelizer digest 1cfcde8cdcef95e311198ef79824c581
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-type ShippingMethod = {
+type DeliveryMethod = {
id: string;
name: string;
code: string | null;
@@ -10,4 +10,4 @@ type ShippingMethod = {
updated_at: string;
}
-export default ShippingMethod;
+export default DeliveryMethod;
diff --git a/packages/admin-sdk/src/types/generated/DeliveryRate.ts b/packages/admin-sdk/src/types/generated/DeliveryRate.ts
new file mode 100644
index 0000000000..fed8e58193
--- /dev/null
+++ b/packages/admin-sdk/src/types/generated/DeliveryRate.ts
@@ -0,0 +1,16 @@
+// Typelizer digest b38c6a7704dcf309289f09a2515d8dd3
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+import type {DeliveryMethod} from '@/types'
+
+type DeliveryRate = {
+ id: string;
+ delivery_method_id: string;
+ name: string;
+ selected: boolean;
+ cost: string;
+ display_cost: string;
+ delivery_method?: DeliveryMethod;
+}
+
+export default DeliveryRate;
diff --git a/packages/admin-sdk/src/types/generated/Shipment.ts b/packages/admin-sdk/src/types/generated/Fulfillment.ts
similarity index 65%
rename from packages/admin-sdk/src/types/generated/Shipment.ts
rename to packages/admin-sdk/src/types/generated/Fulfillment.ts
index f030508d4a..4a3463b0b1 100644
--- a/packages/admin-sdk/src/types/generated/Shipment.ts
+++ b/packages/admin-sdk/src/types/generated/Fulfillment.ts
@@ -1,22 +1,23 @@
-// Typelizer digest 22185938b530f6220c3e3535de330d0a
+// Typelizer digest 7f56e9f37c2dd12376d81fadc9345f84
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {ShippingMethod, StockLocation, ShippingRate, Order, Adjustment} from '@/types'
+import type {DeliveryMethod, StockLocation, DeliveryRate, Order, Adjustment} from '@/types'
-type Shipment = {
+type Fulfillment = {
id: string;
number: string;
- state: string;
tracking: string | null;
tracking_url: string | null;
cost: string;
display_cost: string;
- shipped_at: string | null;
created_at: string;
updated_at: string;
- shipping_method?: ShippingMethod;
+ status: string;
+ fulfillment_type: string;
+ fulfilled_at: string | null;
+ delivery_method?: DeliveryMethod;
stock_location?: StockLocation;
- shipping_rates?: Array<ShippingRate>;
+ delivery_rates?: Array<DeliveryRate>;
adjustment_total: string;
additional_tax_total: string;
included_tax_total: string;
@@ -29,4 +30,4 @@ type Shipment = {
adjustments?: Array<Adjustment>;
}
-export default Shipment;
+export default Fulfillment;
diff --git a/packages/admin-sdk/src/types/generated/Order.ts b/packages/admin-sdk/src/types/generated/Order.ts
index 51c119f04d..75ea05339c 100644
--- a/packages/admin-sdk/src/types/generated/Order.ts
+++ b/packages/admin-sdk/src/types/generated/Order.ts
@@ -1,7 +1,7 @@
-// Typelizer digest 62a8feea70c57de3b193c71ad3674ea1
+// Typelizer digest 549f6dc4fd2e3f7cd37bd8d3286557d5
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {OrderPromotion, LineItem, Shipment, Payment, Address, PaymentMethod, Customer, Adjustment, ReturnAuthorization, Reimbursement} from '@/types'
+import type {OrderPromotion, LineItem, Fulfillment, Payment, Address, PaymentMethod, Customer, Adjustment, ReturnAuthorization, Reimbursement} from '@/types'
type Order = {
id: string;
@@ -11,12 +11,8 @@ type Order = {
currency: string;
locale: string | null;
item_count: number;
- shipment_state: string | null;
- payment_state: string | null;
item_total: string;
display_item_total: string;
- ship_total: string;
- display_ship_total: string;
adjustment_total: string;
display_adjustment_total: string;
promo_total: string;
@@ -32,9 +28,13 @@ type Order = {
completed_at: string | null;
created_at: string;
updated_at: string;
+ fulfillment_status: string | null;
+ payment_status: string | null;
+ delivery_total: string;
+ display_delivery_total: string;
promotions?: Array<OrderPromotion>;
items?: Array<LineItem>;
- shipments?: Array<Shipment>;
+ fulfillments?: Array<Fulfillment>;
payments?: Array<Payment>;
bill_address?: Address | null;
ship_address?: Address | null;
@@ -52,9 +52,9 @@ type Order = {
approver_id: string | null;
canceler_id: string | null;
created_by_id: string | null;
- user_id: string | null;
+ customer_id: string | null;
payment_methods?: Array<PaymentMethod>;
- user?: Customer;
+ customer?: Customer;
approver?: Customer;
canceler?: Customer;
created_by?: Customer;
diff --git a/packages/admin-sdk/src/types/generated/Payment.ts b/packages/admin-sdk/src/types/generated/Payment.ts
index 42b25fa243..1b1ffaef6f 100644
--- a/packages/admin-sdk/src/types/generated/Payment.ts
+++ b/packages/admin-sdk/src/types/generated/Payment.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 02a37df934f101fc3302923c8bd4888b
+// Typelizer digest 45cf73e2d05a8d2a9b9c489553261b79
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {CreditCard, StoreCredit, PaymentSource, PaymentMethod, Order, Refund} from '@/types'
@@ -6,13 +6,13 @@ import type {CreditCard, StoreCredit, PaymentSource, PaymentMethod, Order, Refun
type Payment = {
id: string;
payment_method_id: string;
- state: string;
response_code: string | null;
number: string;
amount: string;
display_amount: string;
created_at: string;
updated_at: string;
+ status: string;
source_type: 'credit_card' | 'store_credit' | 'payment_source' | null;
source_id: string | null;
source: CreditCard | StoreCredit | PaymentSource | null;
diff --git a/packages/admin-sdk/src/types/generated/Product.ts b/packages/admin-sdk/src/types/generated/Product.ts
index 2ca581e387..2ca5871d8a 100644
--- a/packages/admin-sdk/src/types/generated/Product.ts
+++ b/packages/admin-sdk/src/types/generated/Product.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 6b59ae5c6e1c93b3e2889235dda4b17c
+// Typelizer digest 50e186f2d6a5baa654ea1b83bc5430e4
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Price, Media, Variant, OptionType, Category, Metafield} from '@/types'
@@ -27,7 +27,6 @@ type Product = {
media?: Array<Media>;
variants?: Array<Variant>;
default_variant?: Variant;
- master_variant?: Variant;
option_types?: Array<OptionType>;
categories?: Array<Category>;
metafields?: Array<Metafield>;
diff --git a/packages/admin-sdk/src/types/generated/ShippingRate.ts b/packages/admin-sdk/src/types/generated/ShippingRate.ts
deleted file mode 100644
index 4f1360cdf7..0000000000
--- a/packages/admin-sdk/src/types/generated/ShippingRate.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-// Typelizer digest 135199aa04dc78a8767e84b5cf522fe5
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {ShippingMethod} from '@/types'
-
-type ShippingRate = {
- id: string;
- shipping_method_id: string;
- name: string;
- selected: boolean;
- cost: string;
- display_cost: string;
- shipping_method?: ShippingMethod;
-}
-
-export default ShippingRate;
diff --git a/packages/admin-sdk/src/types/generated/StoreCredit.ts b/packages/admin-sdk/src/types/generated/StoreCredit.ts
index f4b12b0c27..6794f92003 100644
--- a/packages/admin-sdk/src/types/generated/StoreCredit.ts
+++ b/packages/admin-sdk/src/types/generated/StoreCredit.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 11ed4ed126cf509bb707e77d947473f5
+// Typelizer digest cd86fec8db846529973a4c51798c5dcb
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -11,7 +11,7 @@ type StoreCredit = {
display_amount_used: string;
display_amount_remaining: string;
currency: string;
- user_id: string | null;
+ customer_id: string | null;
created_by_id: string | null;
metadata: Record<string, unknown> | null;
created_at: string;
diff --git a/packages/admin-sdk/src/types/generated/Variant.ts b/packages/admin-sdk/src/types/generated/Variant.ts
index 8f64e4d0fd..cdcec97ba2 100644
--- a/packages/admin-sdk/src/types/generated/Variant.ts
+++ b/packages/admin-sdk/src/types/generated/Variant.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 0eb33fd101b5908c3453d5f8f75e04a5
+// Typelizer digest 11a16f2d29e991ade611099f457468c5
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Price, Media, OptionValue, Metafield} from '@/types'
@@ -7,7 +7,6 @@ type Variant = {
id: string;
product_id: string;
sku: string | null;
- is_master: boolean;
options_text: string;
track_inventory: boolean;
media_count: number;
diff --git a/packages/admin-sdk/src/types/generated/index.ts b/packages/admin-sdk/src/types/generated/index.ts
index 0aebf70182..5934b6ece7 100644
--- a/packages/admin-sdk/src/types/generated/index.ts
+++ b/packages/admin-sdk/src/types/generated/index.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 5303466aa5441036b50030ebe2bef1c5
+// Typelizer digest 35cd6c6042b48d94ad3e2ac043e468f8
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
export type { default as Address } from './Address'
@@ -9,7 +9,10 @@ export type { default as Asset } from './Asset'
export type { default as Category } from './Category'
export type { default as CreditCard } from './CreditCard'
export type { default as Customer } from './Customer'
+export type { default as DeliveryMethod } from './DeliveryMethod'
+export type { default as DeliveryRate } from './DeliveryRate'
export type { default as DigitalLink } from './DigitalLink'
+export type { default as Fulfillment } from './Fulfillment'
export type { default as LineItem } from './LineItem'
export type { default as Media } from './Media'
export type { default as Metafield } from './Metafield'
@@ -25,10 +28,7 @@ export type { default as Product } from './Product'
export type { default as Refund } from './Refund'
export type { default as Reimbursement } from './Reimbursement'
export type { default as ReturnAuthorization } from './ReturnAuthorization'
-export type { default as Shipment } from './Shipment'
export type { default as ShippingCategory } from './ShippingCategory'
-export type { default as ShippingMethod } from './ShippingMethod'
-export type { default as ShippingRate } from './ShippingRate'
export type { default as StockItem } from './StockItem'
export type { default as StockLocation } from './StockLocation'
export type { default as StoreCredit } from './StoreCredit'
diff --git a/packages/next/.changeset/fulfillment-delivery-rename.md b/packages/next/.changeset/fulfillment-delivery-rename.md
new file mode 100644
index 0000000000..544457c09b
--- /dev/null
+++ b/packages/next/.changeset/fulfillment-delivery-rename.md
@@ -0,0 +1,15 @@
+---
+"@spree/next": minor
+---
+
+### Breaking: Shipping → Delivery/Fulfillment naming
+
+Renamed server actions to match SDK 0.12.0 naming:
+
+- `getShipments()` → `getFulfillments()`
+- `selectShippingRate(shipmentId, rateId)` → `selectDeliveryRate(fulfillmentId, rateId)`
+
+### Updated type re-exports
+
+- `Shipment` → `Fulfillment`
+- `ShippingRate` → `DeliveryRate`
diff --git a/packages/next/CHANGELOG.md b/packages/next/CHANGELOG.md
index d7fe14f600..afe3c67bb7 100644
--- a/packages/next/CHANGELOG.md
+++ b/packages/next/CHANGELOG.md
@@ -1,5 +1,21 @@
# @spree/next
+## 0.12.0
+
+### Minor Changes
+
+- ### Breaking: Shipping → Delivery/Fulfillment naming
+
+ Renamed server actions to match SDK 0.12.0 naming:
+
+ - `getShipments()` → `getFulfillments()`
+ - `selectShippingRate(shipmentId, rateId)` → `selectDeliveryRate(fulfillmentId, rateId)`
+
+ ### Updated type re-exports
+
+ - `Shipment` → `Fulfillment`
+ - `ShippingRate` → `DeliveryRate`
+
## 0.11.0
### Minor Changes
diff --git a/packages/next/README.md b/packages/next/README.md
index 8cc5371d08..9e90688634 100644
--- a/packages/next/README.md
+++ b/packages/next/README.md
@@ -144,8 +144,8 @@ All checkout functions operate on the current cart implicitly (via the cart cook
import {
getCheckout,
updateCheckout,
- getShipments,
- selectShippingRate,
+ getFulfillments,
+ selectDeliveryRate,
applyCoupon,
removeCoupon,
complete,
@@ -153,8 +153,8 @@ import {
const checkout = await getCheckout();
await updateCheckout({ ship_address: { ... }, bill_address: { ... } });
-const shipments = await getShipments();
-await selectShippingRate(shipmentId, rateId);
+const fulfillments = await getFulfillments();
+await selectDeliveryRate(fulfillmentId, rateId);
await applyCoupon('SAVE20');
await removeCoupon('SAVE20');
await complete();
diff --git a/packages/next/package.json b/packages/next/package.json
index e2f9b246f2..81c925644f 100644
--- a/packages/next/package.json
+++ b/packages/next/package.json
@@ -1,6 +1,6 @@
{
"name": "@spree/next",
- "version": "0.11.0",
+ "version": "0.12.0",
"description": "Next.js integration for Spree Commerce — server actions, caching, and cookie-based auth",
"type": "module",
"main": "./dist/index.js",
@@ -62,7 +62,7 @@
"url": "https://github.com/spree/spree/issues"
},
"peerDependencies": {
- "@spree/sdk": ">=0.10.1",
+ "@spree/sdk": ">=0.12.0",
"next": ">=15.0.0",
"react": ">=19.0.0"
},
diff --git a/packages/next/src/actions/cart.ts b/packages/next/src/actions/cart.ts
index ea8db6e246..90aba69956 100644
--- a/packages/next/src/actions/cart.ts
+++ b/packages/next/src/actions/cart.ts
@@ -1,7 +1,7 @@
'use server';
import { revalidateTag } from 'next/cache';
-import type { Cart, Order, Shipment, CreateCartParams, UpdateCartParams, ListResponse } from '@spree/sdk';
+import type { Cart, Order, Fulfillment, CreateCartParams, UpdateCartParams, ListResponse } from '@spree/sdk';
import { getClient } from '../config';
import {
getCartToken, getCartId,
@@ -169,28 +169,28 @@ export async function updateCart(
}
/**
- * Get shipments with shipping rates for the current cart.
+ * Get fulfillments with delivery rates for the current cart.
*/
-export async function getShipments(): Promise<ListResponse<Shipment>> {
+export async function getFulfillments(): Promise<ListResponse<Fulfillment>> {
const options = await getCartOptions();
const cartId = await requireCartId();
- return getClient().carts.shipments.list(cartId, options);
+ return getClient().carts.fulfillments.list(cartId, options);
}
/**
- * Select a shipping rate for a shipment.
+ * Select a delivery rate for a fulfillment.
* Returns the updated cart with recalculated totals.
*/
-export async function selectShippingRate(
- shipmentId: string,
- shippingRateId: string
+export async function selectDeliveryRate(
+ fulfillmentId: string,
+ deliveryRateId: string
): Promise<Cart> {
const options = await getCartOptions();
const cartId = await requireCartId();
- const result = await getClient().carts.shipments.update(
+ const result = await getClient().carts.fulfillments.update(
cartId,
- shipmentId,
- { selected_shipping_rate_id: shippingRateId },
+ fulfillmentId,
+ { selected_delivery_rate_id: deliveryRateId },
options
);
revalidateTag('checkout');
diff --git a/packages/next/src/index.ts b/packages/next/src/index.ts
index 7b475ce521..a7f39e519a 100644
--- a/packages/next/src/index.ts
+++ b/packages/next/src/index.ts
@@ -20,8 +20,8 @@ export {
clearCart,
associateCart,
updateCart,
- getShipments,
- selectShippingRate,
+ getFulfillments,
+ selectDeliveryRate,
applyCoupon,
removeCoupon,
complete,
@@ -82,8 +82,8 @@ export type {
CreditCard,
DigitalLink,
GiftCard,
- Shipment,
- ShippingRate,
+ Fulfillment,
+ DeliveryRate,
Payment,
PaymentMethod,
PaymentSession,
diff --git a/packages/next/tests/actions/cart.test.ts b/packages/next/tests/actions/cart.test.ts
index 7f5a24e68f..561d6caae6 100644
--- a/packages/next/tests/actions/cart.test.ts
+++ b/packages/next/tests/actions/cart.test.ts
@@ -16,7 +16,7 @@ const mockClient = {
update: vi.fn(),
delete: vi.fn(),
},
- shipments: {
+ fulfillments: {
list: vi.fn(),
update: vi.fn(),
},
@@ -33,7 +33,7 @@ vi.mock('@spree/sdk', () => ({
import {
getCart, getOrCreateCart, addItem, updateItem, removeItem, clearCart, associateCart,
- updateCart, getShipments, selectShippingRate, applyCoupon, removeCoupon, complete,
+ updateCart, getFulfillments, selectDeliveryRate, applyCoupon, removeCoupon, complete,
} from '../../src/actions/cart';
import { revalidateTag } from 'next/cache';
@@ -253,41 +253,41 @@ describe('cart actions', () => {
});
});
- describe('getShipments', () => {
- it('returns shipments for the cart', async () => {
- const mockShipments = { data: [{ id: 's1', shipping_rates: [] }] };
+ describe('getFulfillments', () => {
+ it('returns fulfillments for the cart', async () => {
+ const mockFulfillments = { data: [{ id: 'ful_1', delivery_rates: [] }] };
mockCookies({
'_spree_cart_token': 'order_token',
'_spree_cart_token_id': 'cart_1',
'_spree_jwt': 'jwt_token',
});
- mockClient.carts.shipments.list.mockResolvedValue(mockShipments);
+ mockClient.carts.fulfillments.list.mockResolvedValue(mockFulfillments);
- const result = await getShipments();
- expect(result).toEqual(mockShipments);
- expect(mockClient.carts.shipments.list).toHaveBeenCalledWith(
+ const result = await getFulfillments();
+ expect(result).toEqual(mockFulfillments);
+ expect(mockClient.carts.fulfillments.list).toHaveBeenCalledWith(
'cart_1',
{ spreeToken: 'order_token', token: 'jwt_token' }
);
});
});
- describe('selectShippingRate', () => {
- it('selects shipping rate and revalidates', async () => {
- const updatedCart = { id: 'cart_1', ship_total: '10.0' };
+ describe('selectDeliveryRate', () => {
+ it('selects delivery rate and revalidates', async () => {
+ const updatedCart = { id: 'cart_1', delivery_total: '10.0' };
mockCookies({
'_spree_cart_token': 'order_token',
'_spree_cart_token_id': 'cart_1',
'_spree_jwt': 'jwt_token',
});
- mockClient.carts.shipments.update.mockResolvedValue(updatedCart);
+ mockClient.carts.fulfillments.update.mockResolvedValue(updatedCart);
- const result = await selectShippingRate('s1', 'sr1');
+ const result = await selectDeliveryRate('ful_1', 'dr_1');
expect(result).toEqual(updatedCart);
- expect(mockClient.carts.shipments.update).toHaveBeenCalledWith(
+ expect(mockClient.carts.fulfillments.update).toHaveBeenCalledWith(
'cart_1',
- 's1',
- { selected_shipping_rate_id: 'sr1' },
+ 'ful_1',
+ { selected_delivery_rate_id: 'dr_1' },
{ spreeToken: 'order_token', token: 'jwt_token' }
);
expect(revalidateTag).toHaveBeenCalledWith('checkout');
diff --git a/packages/sdk/.changeset/fulfillment-delivery-rename.md b/packages/sdk/.changeset/fulfillment-delivery-rename.md
new file mode 100644
index 0000000000..1e4fc61676
--- /dev/null
+++ b/packages/sdk/.changeset/fulfillment-delivery-rename.md
@@ -0,0 +1,32 @@
+---
+"@spree/sdk": minor
+---
+
+### Breaking: Shipping → Delivery/Fulfillment naming
+
+Renamed all shipping/shipment API surface to use delivery/fulfillment vocabulary:
+
+- `client.carts.shipments` → `client.carts.fulfillments`
+- `selected_shipping_rate_id` param → `selected_delivery_rate_id`
+- `/carts/:id/shipments` endpoint → `/carts/:id/fulfillments`
+
+### Breaking: Renamed response fields
+
+- `shipment_state` → `fulfillment_status` (on Order)
+- `payment_state` → `payment_status` (on Order)
+- `ship_total` / `display_ship_total` → `delivery_total` / `display_delivery_total` (on Cart/Order)
+- `state` → `status` (on Payment, GiftCard)
+- `shipped_at` → `fulfilled_at` (on Fulfillment)
+- `shipping_method` → `delivery_method` (on Fulfillment, DeliveryRate)
+- `shipping_rates` → `delivery_rates` (on Fulfillment)
+
+### Breaking: Removed fields
+
+- Removed `is_master` from Variant
+- Removed `expand=master_variant` from Product (use `expand=default_variant`)
+
+### Type renames
+
+- `Shipment` → `Fulfillment` / `StoreFulfillment`
+- `ShippingMethod` → `DeliveryMethod` / `StoreDeliveryMethod`
+- `ShippingRate` → `DeliveryRate` / `StoreDeliveryRate`
diff --git a/packages/sdk/CHANGELOG.md b/packages/sdk/CHANGELOG.md
index 1e69e1bebc..1f0bc95a90 100644
--- a/packages/sdk/CHANGELOG.md
+++ b/packages/sdk/CHANGELOG.md
@@ -1,5 +1,38 @@
# @spree/sdk
+## 0.12.0
+
+### Minor Changes
+
+- ### Breaking: Shipping → Delivery/Fulfillment naming
+
+ Renamed all shipping/shipment API surface to use delivery/fulfillment vocabulary:
+
+ - `client.carts.shipments` → `client.carts.fulfillments`
+ - `selected_shipping_rate_id` param → `selected_delivery_rate_id`
+ - `/carts/:id/shipments` endpoint → `/carts/:id/fulfillments`
+
+ ### Breaking: Renamed response fields
+
+ - `shipment_state` → `fulfillment_status` (on Order)
+ - `payment_state` → `payment_status` (on Order)
+ - `ship_total` / `display_ship_total` → `delivery_total` / `display_delivery_total` (on Cart/Order)
+ - `state` → `status` (on Payment, GiftCard)
+ - `shipped_at` → `fulfilled_at` (on Fulfillment)
+ - `shipping_method` → `delivery_method` (on Fulfillment, DeliveryRate)
+ - `shipping_rates` → `delivery_rates` (on Fulfillment)
+
+ ### Breaking: Removed fields
+
+ - Removed `is_master` from Variant
+ - Removed `expand=master_variant` from Product (use `expand=default_variant`)
+
+ ### Type renames
+
+ - `Shipment` → `Fulfillment` / `StoreFulfillment`
+ - `ShippingMethod` → `DeliveryMethod` / `StoreDeliveryMethod`
+ - `ShippingRate` → `DeliveryRate` / `StoreDeliveryRate`
+
## 0.11.0
### Minor Changes
diff --git a/packages/sdk/README.md b/packages/sdk/README.md
index 8fd2c1afb7..4697ed40db 100644
--- a/packages/sdk/README.md
+++ b/packages/sdk/README.md
@@ -265,17 +265,17 @@ await client.carts.couponCodes.apply('cart_xxx', 'SAVE20', options);
await client.carts.couponCodes.remove('cart_xxx', 'SAVE20', options);
```
-### Shipments
+### Fulfillments
```typescript
const options = { spreeToken: cart.token };
-// List shipments for the cart
-const shipments = await client.carts.shipments.list('cart_xxx', options);
+// List fulfillments for the cart
+const fulfillments = await client.carts.fulfillments.list('cart_xxx', options);
-// Select a shipping rate
-await client.carts.shipments.update('cart_xxx', shipmentId, {
- selected_shipping_rate_id: 'rate_xxx',
+// Select a delivery rate
+await client.carts.fulfillments.update('cart_xxx', fulfillmentId, {
+ selected_delivery_rate_id: 'rate_xxx',
}, options);
```
@@ -368,7 +368,7 @@ Completed orders can be looked up by ID or number:
```typescript
// Get a completed order by ID or number
const order = await client.orders.get('R123456789', {
- expand: ['items', 'shipments'],
+ expand: ['items', 'fulfillments'],
}, { spreeToken: orderToken });
```
@@ -382,7 +382,7 @@ const orders = await client.customer.orders.list({}, options);
// Get a specific order from history
const order = await client.customer.orders.get('or_xxx', {
- expand: ['items', 'shipments'],
+ expand: ['items', 'fulfillments'],
}, options);
```
@@ -558,7 +558,7 @@ The SDK uses a resource builder pattern for nested resources:
|-----------------|-----------------|-------------------|
| `carts` | `items` | `create`, `update`, `delete` |
| `carts` | `couponCodes` | `apply`, `remove` |
-| `carts` | `shipments` | `list`, `update` |
+| `carts` | `fulfillments` | `list`, `update` |
| `carts` | `paymentMethods` | `list` |
| `carts` | `payments` | `list`, `get`, `create` |
| `carts` | `paymentSessions` | `create`, `get`, `update`, `complete` |
@@ -577,7 +577,7 @@ Example:
// Cart resources take cartId as first argument
await client.carts.items.create(cartId, params, options);
await client.carts.couponCodes.apply(cartId, code, options);
-await client.carts.shipments.update(cartId, shipmentId, params, options);
+await client.carts.fulfillments.update(cartId, fulfillmentId, params, options);
await client.carts.payments.list(cartId, options);
await client.carts.paymentSessions.create(cartId, params, options);
await client.carts.storeCredits.apply(cartId, amount, options);
@@ -691,9 +691,9 @@ The SDK exports all Store API types:
- `StorePayment` - Payment record
- `StorePaymentMethod` - Payment method
- `StorePaymentSession` - Provider-agnostic payment session
-- `StoreShipment` - Shipment record
-- `StoreShippingRate` - Shipping rate option
-- `StoreShippingMethod` - Shipping method
+- `StoreFulfillment` - Fulfillment record
+- `StoreDeliveryRate` - Delivery rate option
+- `StoreDeliveryMethod` - Delivery method
- `StoreCreditCard` - Saved credit card
- `StoreGiftCard` - Gift card
- `StoreCartPromotion` - Promotion applied to a cart (uses `cpromo_` prefixed IDs)
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
index ffd2c893fb..39da709915 100644
--- a/packages/sdk/package.json
+++ b/packages/sdk/package.json
@@ -1,6 +1,6 @@
{
"name": "@spree/sdk",
- "version": "0.11.0",
+ "version": "0.12.0",
"description": "Official TypeScript SDK for Spree Commerce Store API",
"type": "module",
"main": "./dist/index.cjs",
diff --git a/packages/sdk/src/store-client.ts b/packages/sdk/src/store-client.ts
index 2f365287de..64efcf7f40 100644
--- a/packages/sdk/src/store-client.ts
+++ b/packages/sdk/src/store-client.ts
@@ -41,7 +41,7 @@ import type {
PaymentMethod,
PaymentSession,
PaymentSetupSession,
- Shipment,
+ Fulfillment,
Wishlist,
WishedItem,
Address,
@@ -435,34 +435,34 @@ export class StoreClient {
},
/**
- * Nested resource: Shipments
+ * Nested resource: Fulfillments
*/
- shipments: {
+ fulfillments: {
/**
- * List shipments with shipping rates for the cart
+ * List fulfillments with delivery rates for the cart
* @param cartId - Cart prefixed ID
*/
- list: (cartId: string, options?: RequestOptions): Promise<ListResponse<Shipment>> =>
- this.request<ListResponse<Shipment>>(
+ list: (cartId: string, options?: RequestOptions): Promise<ListResponse<Fulfillment>> =>
+ this.request<ListResponse<Fulfillment>>(
'GET',
- `/carts/${cartId}/shipments`,
+ `/carts/${cartId}/fulfillments`,
options
),
/**
- * Select a shipping rate for a specific shipment.
+ * Select a delivery rate for a specific fulfillment.
* Returns the updated cart with recalculated totals.
* @param cartId - Cart prefixed ID
*/
update: (
cartId: string,
- shipmentId: string,
- params: { selected_shipping_rate_id: string },
+ fulfillmentId: string,
+ params: { selected_delivery_rate_id: string },
options?: RequestOptions
): Promise<Cart> =>
this.request<Cart>(
'PATCH',
- `/carts/${cartId}/shipments/${shipmentId}`,
+ `/carts/${cartId}/fulfillments/${fulfillmentId}`,
{ ...options, body: params }
),
},
diff --git a/packages/sdk/src/types/generated/Cart.ts b/packages/sdk/src/types/generated/Cart.ts
index 69b9243343..e1e89b9529 100644
--- a/packages/sdk/src/types/generated/Cart.ts
+++ b/packages/sdk/src/types/generated/Cart.ts
@@ -1,7 +1,7 @@
-// Typelizer digest 42a3a95104e213338454965d6434e06a
+// Typelizer digest 2b3fcada9fd207d7419f3c6d6460756c
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {CartPromotion, LineItem, Shipment, Payment, Address, PaymentMethod} from '@/types'
+import type {CartPromotion, LineItem, Fulfillment, Payment, Address, PaymentMethod} from '@/types'
type Cart = {
id: string;
@@ -14,8 +14,6 @@ type Cart = {
item_count: number;
item_total: string;
display_item_total: string;
- ship_total: string;
- display_ship_total: string;
adjustment_total: string;
display_adjustment_total: string;
promo_total: string;
@@ -30,12 +28,14 @@ type Cart = {
display_total: string;
created_at: string;
updated_at: string;
+ delivery_total: string;
+ display_delivery_total: string;
current_step: string;
completed_steps: Array<string>;
requirements: Array<{step: string, field: string, message: string}>;
promotions: Array<CartPromotion>;
items: Array<LineItem>;
- shipments: Array<Shipment>;
+ fulfillments: Array<Fulfillment>;
payments: Array<Payment>;
bill_address: Address | null;
ship_address: Address | null;
diff --git a/packages/sdk/src/types/generated/ShippingMethod.ts b/packages/sdk/src/types/generated/DeliveryMethod.ts
similarity index 54%
rename from packages/sdk/src/types/generated/ShippingMethod.ts
rename to packages/sdk/src/types/generated/DeliveryMethod.ts
index a73dd083eb..d38ea8311d 100644
--- a/packages/sdk/src/types/generated/ShippingMethod.ts
+++ b/packages/sdk/src/types/generated/DeliveryMethod.ts
@@ -1,11 +1,11 @@
-// Typelizer digest 5d7b7cc09badd722c91dc066a39b95f2
+// Typelizer digest 73976ea026b1762e293030c42cb9a7fb
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-type ShippingMethod = {
+type DeliveryMethod = {
id: string;
name: string;
code: string | null;
}
-export default ShippingMethod;
+export default DeliveryMethod;
diff --git a/packages/sdk/src/types/generated/DeliveryRate.ts b/packages/sdk/src/types/generated/DeliveryRate.ts
new file mode 100644
index 0000000000..836b3cba57
--- /dev/null
+++ b/packages/sdk/src/types/generated/DeliveryRate.ts
@@ -0,0 +1,16 @@
+// Typelizer digest 172f6a161a7d3bcbbc89ce880f8b21d4
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+import type {DeliveryMethod} from '@/types'
+
+type DeliveryRate = {
+ id: string;
+ delivery_method_id: string;
+ name: string;
+ selected: boolean;
+ cost: string;
+ display_cost: string;
+ delivery_method: DeliveryMethod;
+}
+
+export default DeliveryRate;
diff --git a/packages/sdk/src/types/generated/Fulfillment.ts b/packages/sdk/src/types/generated/Fulfillment.ts
new file mode 100644
index 0000000000..594c822600
--- /dev/null
+++ b/packages/sdk/src/types/generated/Fulfillment.ts
@@ -0,0 +1,23 @@
+// Typelizer digest d59d4eb042aa0d6c9c7b791c6f533e02
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+import type {DeliveryMethod, StockLocation, DeliveryRate} from '@/types'
+
+type Fulfillment = {
+ id: string;
+ number: string;
+ tracking: string | null;
+ tracking_url: string | null;
+ cost: string;
+ display_cost: string;
+ created_at: string;
+ updated_at: string;
+ status: string;
+ fulfillment_type: string;
+ fulfilled_at: string | null;
+ delivery_method: DeliveryMethod;
+ stock_location: StockLocation;
+ delivery_rates: Array<DeliveryRate>;
+}
+
+export default Fulfillment;
diff --git a/packages/sdk/src/types/generated/GiftCard.ts b/packages/sdk/src/types/generated/GiftCard.ts
index de8b8a9d1c..3097b634c7 100644
--- a/packages/sdk/src/types/generated/GiftCard.ts
+++ b/packages/sdk/src/types/generated/GiftCard.ts
@@ -1,11 +1,11 @@
-// Typelizer digest 57cc98c1a72c8746c1d34d1c0a63053e
+// Typelizer digest 47121a3f3103923c6389104d95eb4a23
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
type GiftCard = {
id: string;
code: string;
- state: string;
+ status: string;
currency: string;
amount: string;
amount_used: string;
diff --git a/packages/sdk/src/types/generated/NewsletterSubscriber.ts b/packages/sdk/src/types/generated/NewsletterSubscriber.ts
index eeaf8b7ff3..49ddac9c25 100644
--- a/packages/sdk/src/types/generated/NewsletterSubscriber.ts
+++ b/packages/sdk/src/types/generated/NewsletterSubscriber.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 86bdbd86a8b56514e956392b35a7dad0
+// Typelizer digest 23b1354b4c1c34e3ea9c78ff2ee1ae58
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -9,7 +9,7 @@ type NewsletterSubscriber = {
updated_at: string;
verified: boolean;
verified_at: string | null;
- user_id: string | null;
+ customer_id: string | null;
}
export default NewsletterSubscriber;
diff --git a/packages/sdk/src/types/generated/Order.ts b/packages/sdk/src/types/generated/Order.ts
index 81ee4fd4e7..199c6d4106 100644
--- a/packages/sdk/src/types/generated/Order.ts
+++ b/packages/sdk/src/types/generated/Order.ts
@@ -1,7 +1,7 @@
-// Typelizer digest d1c33d8d2b45afa6cbe3b585a13796fd
+// Typelizer digest 39e430d8615139aab548aeb629896db8
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {OrderPromotion, LineItem, Shipment, Payment, Address} from '@/types'
+import type {OrderPromotion, LineItem, Fulfillment, Payment, Address} from '@/types'
type Order = {
id: string;
@@ -11,12 +11,8 @@ type Order = {
currency: string;
locale: string | null;
item_count: number;
- shipment_state: string | null;
- payment_state: string | null;
item_total: string;
display_item_total: string;
- ship_total: string;
- display_ship_total: string;
adjustment_total: string;
display_adjustment_total: string;
promo_total: string;
@@ -32,9 +28,13 @@ type Order = {
completed_at: string | null;
created_at: string;
updated_at: string;
+ fulfillment_status: string | null;
+ payment_status: string | null;
+ delivery_total: string;
+ display_delivery_total: string;
promotions: Array<OrderPromotion>;
items: Array<LineItem>;
- shipments: Array<Shipment>;
+ fulfillments: Array<Fulfillment>;
payments: Array<Payment>;
bill_address: Address | null;
ship_address: Address | null;
diff --git a/packages/sdk/src/types/generated/Payment.ts b/packages/sdk/src/types/generated/Payment.ts
index 5ce6929868..851edc8678 100644
--- a/packages/sdk/src/types/generated/Payment.ts
+++ b/packages/sdk/src/types/generated/Payment.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 63ed93c8f3ba3f598d5e82ef5f38a935
+// Typelizer digest ddc57d7a11ce548446095b5a859b55b3
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {CreditCard, StoreCredit, PaymentSource, PaymentMethod} from '@/types'
@@ -6,13 +6,13 @@ import type {CreditCard, StoreCredit, PaymentSource, PaymentMethod} from '@/type
type Payment = {
id: string;
payment_method_id: string;
- state: string;
response_code: string | null;
number: string;
amount: string;
display_amount: string;
created_at: string;
updated_at: string;
+ status: string;
source_type: 'credit_card' | 'store_credit' | 'payment_source' | null;
source_id: string | null;
source: CreditCard | StoreCredit | PaymentSource | null;
diff --git a/packages/sdk/src/types/generated/Product.ts b/packages/sdk/src/types/generated/Product.ts
index 32d344047b..50a5679e34 100644
--- a/packages/sdk/src/types/generated/Product.ts
+++ b/packages/sdk/src/types/generated/Product.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 81d9c7e30819ca27528939932201fa4f
+// Typelizer digest 9979216d3303ad575626426a7bcbfa5e
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Price, Media, Variant, OptionType, Category, Metafield} from '@/types'
@@ -27,7 +27,6 @@ type Product = {
media?: Array<Media>;
variants?: Array<Variant>;
default_variant?: Variant;
- master_variant?: Variant;
option_types?: Array<OptionType>;
categories?: Array<Category>;
metafields?: Array<Metafield>;
diff --git a/packages/sdk/src/types/generated/Shipment.ts b/packages/sdk/src/types/generated/Shipment.ts
deleted file mode 100644
index 0ff07e445c..0000000000
--- a/packages/sdk/src/types/generated/Shipment.ts
+++ /dev/null
@@ -1,22 +0,0 @@
-// Typelizer digest d49d444cd23cd77b0eb4114d5ae3562c
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {ShippingMethod, StockLocation, ShippingRate} from '@/types'
-
-type Shipment = {
- id: string;
- number: string;
- state: string;
- tracking: string | null;
- tracking_url: string | null;
- cost: string;
- display_cost: string;
- shipped_at: string | null;
- created_at: string;
- updated_at: string;
- shipping_method: ShippingMethod;
- stock_location: StockLocation;
- shipping_rates: Array<ShippingRate>;
-}
-
-export default Shipment;
diff --git a/packages/sdk/src/types/generated/ShippingRate.ts b/packages/sdk/src/types/generated/ShippingRate.ts
deleted file mode 100644
index f36524c997..0000000000
--- a/packages/sdk/src/types/generated/ShippingRate.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-// Typelizer digest c982be6e831e6b362f7ad6f702328c4b
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {ShippingMethod} from '@/types'
-
-type ShippingRate = {
- id: string;
- shipping_method_id: string;
- name: string;
- selected: boolean;
- cost: string;
- display_cost: string;
- shipping_method: ShippingMethod;
-}
-
-export default ShippingRate;
diff --git a/packages/sdk/src/types/generated/Variant.ts b/packages/sdk/src/types/generated/Variant.ts
index 5e01787624..3ac3c51d79 100644
--- a/packages/sdk/src/types/generated/Variant.ts
+++ b/packages/sdk/src/types/generated/Variant.ts
@@ -1,4 +1,4 @@
-// Typelizer digest f6ba1f2e259f0c8a6027c706aedac647
+// Typelizer digest 37c8a7e0fead658658f18bc804ecc746
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Price, Media, OptionValue, Metafield} from '@/types'
@@ -7,7 +7,6 @@ type Variant = {
id: string;
product_id: string;
sku: string | null;
- is_master: boolean;
options_text: string;
track_inventory: boolean;
media_count: number;
diff --git a/packages/sdk/src/types/generated/index.ts b/packages/sdk/src/types/generated/index.ts
index 4e56b500c1..db56531377 100644
--- a/packages/sdk/src/types/generated/index.ts
+++ b/packages/sdk/src/types/generated/index.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 06b4c1b4ec7e795574441c291ca84959
+// Typelizer digest 49cc65a997ae2b72cd4d5427d79d9cde
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
export type { default as Address } from './Address'
@@ -12,9 +12,12 @@ export type { default as CreditCard } from './CreditCard'
export type { default as Currency } from './Currency'
export type { default as CustomerReturn } from './CustomerReturn'
export type { default as Customer } from './Customer'
+export type { default as DeliveryMethod } from './DeliveryMethod'
+export type { default as DeliveryRate } from './DeliveryRate'
export type { default as DigitalLink } from './DigitalLink'
export type { default as Digital } from './Digital'
export type { default as Export } from './Export'
+export type { default as Fulfillment } from './Fulfillment'
export type { default as GiftCardBatch } from './GiftCardBatch'
export type { default as GiftCard } from './GiftCard'
export type { default as ImportRow } from './ImportRow'
@@ -43,10 +46,7 @@ export type { default as Reimbursement } from './Reimbursement'
export type { default as Report } from './Report'
export type { default as ReturnAuthorization } from './ReturnAuthorization'
export type { default as ReturnItem } from './ReturnItem'
-export type { default as Shipment } from './Shipment'
export type { default as ShippingCategory } from './ShippingCategory'
-export type { default as ShippingMethod } from './ShippingMethod'
-export type { default as ShippingRate } from './ShippingRate'
export type { default as State } from './State'
export type { default as StockItem } from './StockItem'
export type { default as StockLocation } from './StockLocation'
diff --git a/packages/sdk/src/types/index.ts b/packages/sdk/src/types/index.ts
index 3aa8a09d59..12d93a490a 100644
--- a/packages/sdk/src/types/index.ts
+++ b/packages/sdk/src/types/index.ts
@@ -44,10 +44,10 @@ export type {
Report,
ReturnAuthorization,
ReturnItem,
- Shipment,
+ DeliveryMethod,
+ DeliveryRate,
+ Fulfillment,
ShippingCategory,
- ShippingMethod,
- ShippingRate,
State,
StockItem,
StockLocation,
@@ -96,10 +96,10 @@ export type { Refund as StoreRefund } from './generated';
export type { Reimbursement as StoreReimbursement } from './generated';
export type { ReturnAuthorization as StoreReturnAuthorization } from './generated';
export type { ReturnItem as StoreReturnItem } from './generated';
-export type { Shipment as StoreShipment } from './generated';
+export type { DeliveryMethod as StoreDeliveryMethod } from './generated';
+export type { DeliveryRate as StoreDeliveryRate } from './generated';
+export type { Fulfillment as StoreFulfillment } from './generated';
export type { ShippingCategory as StoreShippingCategory } from './generated';
-export type { ShippingMethod as StoreShippingMethod } from './generated';
-export type { ShippingRate as StoreShippingRate } from './generated';
export type { State as StoreState } from './generated';
export type { StockItem as StoreStockItem } from './generated';
export type { StockLocation as StoreStockLocation } from './generated';
diff --git a/packages/sdk/src/zod/generated/Cart.ts b/packages/sdk/src/zod/generated/Cart.ts
index f403520fa5..9b7a387cd5 100644
--- a/packages/sdk/src/zod/generated/Cart.ts
+++ b/packages/sdk/src/zod/generated/Cart.ts
@@ -2,10 +2,10 @@
import { z } from 'zod';
import { AddressSchema } from './Address';
import { CartPromotionSchema } from './CartPromotion';
+import { FulfillmentSchema } from './Fulfillment';
import { LineItemSchema } from './LineItem';
import { PaymentSchema } from './Payment';
import { PaymentMethodSchema } from './PaymentMethod';
-import { ShipmentSchema } from './Shipment';
export const CartSchema = z.object({
id: z.string(),
@@ -18,8 +18,6 @@ export const CartSchema = z.object({
item_count: z.number(),
item_total: z.string(),
display_item_total: z.string(),
- ship_total: z.string(),
- display_ship_total: z.string(),
adjustment_total: z.string(),
display_adjustment_total: z.string(),
promo_total: z.string(),
@@ -34,12 +32,14 @@ export const CartSchema = z.object({
display_total: z.string(),
created_at: z.string(),
updated_at: z.string(),
+ delivery_total: z.string(),
+ display_delivery_total: z.string(),
current_step: z.string(),
completed_steps: z.array(z.string()),
requirements: z.array(z.object({ step: z.string(), field: z.string(), message: z.string() })),
promotions: z.array(CartPromotionSchema),
items: z.array(LineItemSchema),
- shipments: z.array(ShipmentSchema),
+ fulfillments: z.array(FulfillmentSchema),
payments: z.array(PaymentSchema),
bill_address: AddressSchema.nullable(),
ship_address: AddressSchema.nullable(),
diff --git a/packages/sdk/src/zod/generated/ShippingMethod.ts b/packages/sdk/src/zod/generated/DeliveryMethod.ts
similarity index 58%
rename from packages/sdk/src/zod/generated/ShippingMethod.ts
rename to packages/sdk/src/zod/generated/DeliveryMethod.ts
index 646058ccb7..8701d5ec4e 100644
--- a/packages/sdk/src/zod/generated/ShippingMethod.ts
+++ b/packages/sdk/src/zod/generated/DeliveryMethod.ts
@@ -1,10 +1,10 @@
// This file is auto-generated. Do not edit directly.
import { z } from 'zod';
-export const ShippingMethodSchema = z.object({
+export const DeliveryMethodSchema = z.object({
id: z.string(),
name: z.string(),
code: z.string().nullable(),
});
-export type ShippingMethod = z.infer<typeof ShippingMethodSchema>;
+export type DeliveryMethod = z.infer<typeof DeliveryMethodSchema>;
diff --git a/packages/sdk/src/zod/generated/DeliveryRate.ts b/packages/sdk/src/zod/generated/DeliveryRate.ts
new file mode 100644
index 0000000000..1ff2e211b0
--- /dev/null
+++ b/packages/sdk/src/zod/generated/DeliveryRate.ts
@@ -0,0 +1,15 @@
+// This file is auto-generated. Do not edit directly.
+import { z } from 'zod';
+import { DeliveryMethodSchema } from './DeliveryMethod';
+
+export const DeliveryRateSchema = z.object({
+ id: z.string(),
+ delivery_method_id: z.string(),
+ name: z.string(),
+ selected: z.boolean(),
+ cost: z.string(),
+ display_cost: z.string(),
+ delivery_method: DeliveryMethodSchema,
+});
+
+export type DeliveryRate = z.infer<typeof DeliveryRateSchema>;
diff --git a/packages/sdk/src/zod/generated/Fulfillment.ts b/packages/sdk/src/zod/generated/Fulfillment.ts
new file mode 100644
index 0000000000..960e32ba7a
--- /dev/null
+++ b/packages/sdk/src/zod/generated/Fulfillment.ts
@@ -0,0 +1,24 @@
+// This file is auto-generated. Do not edit directly.
+import { z } from 'zod';
+import { DeliveryMethodSchema } from './DeliveryMethod';
+import { DeliveryRateSchema } from './DeliveryRate';
+import { StockLocationSchema } from './StockLocation';
+
+export const FulfillmentSchema = z.object({
+ id: z.string(),
+ number: z.string(),
+ tracking: z.string().nullable(),
+ tracking_url: z.string().nullable(),
+ cost: z.string(),
+ display_cost: z.string(),
+ created_at: z.string(),
+ updated_at: z.string(),
+ status: z.string(),
+ fulfillment_type: z.string(),
+ fulfilled_at: z.string().nullable(),
+ delivery_method: DeliveryMethodSchema,
+ stock_location: StockLocationSchema,
+ delivery_rates: z.array(DeliveryRateSchema),
+});
+
+export type Fulfillment = z.infer<typeof FulfillmentSchema>;
diff --git a/packages/sdk/src/zod/generated/GiftCard.ts b/packages/sdk/src/zod/generated/GiftCard.ts
index 4adac37ccf..c66fd93ff1 100644
--- a/packages/sdk/src/zod/generated/GiftCard.ts
+++ b/packages/sdk/src/zod/generated/GiftCard.ts
@@ -4,7 +4,7 @@ import { z } from 'zod';
export const GiftCardSchema = z.object({
id: z.string(),
code: z.string(),
- state: z.string(),
+ status: z.string(),
currency: z.string(),
amount: z.string(),
amount_used: z.string(),
diff --git a/packages/sdk/src/zod/generated/NewsletterSubscriber.ts b/packages/sdk/src/zod/generated/NewsletterSubscriber.ts
index 282a6bd5cb..796d409434 100644
--- a/packages/sdk/src/zod/generated/NewsletterSubscriber.ts
+++ b/packages/sdk/src/zod/generated/NewsletterSubscriber.ts
@@ -8,7 +8,7 @@ export const NewsletterSubscriberSchema = z.object({
updated_at: z.string(),
verified: z.boolean(),
verified_at: z.string().nullable(),
- user_id: z.string().nullable(),
+ customer_id: z.string().nullable(),
});
export type NewsletterSubscriber = z.infer<typeof NewsletterSubscriberSchema>;
diff --git a/packages/sdk/src/zod/generated/Order.ts b/packages/sdk/src/zod/generated/Order.ts
index 311f77add9..4a33a95cba 100644
--- a/packages/sdk/src/zod/generated/Order.ts
+++ b/packages/sdk/src/zod/generated/Order.ts
@@ -1,10 +1,10 @@
// This file is auto-generated. Do not edit directly.
import { z } from 'zod';
import { AddressSchema } from './Address';
+import { FulfillmentSchema } from './Fulfillment';
import { LineItemSchema } from './LineItem';
import { OrderPromotionSchema } from './OrderPromotion';
import { PaymentSchema } from './Payment';
-import { ShipmentSchema } from './Shipment';
export const OrderSchema = z.object({
id: z.string(),
@@ -14,12 +14,8 @@ export const OrderSchema = z.object({
currency: z.string(),
locale: z.string().nullable(),
item_count: z.number(),
- shipment_state: z.string().nullable(),
- payment_state: z.string().nullable(),
item_total: z.string(),
display_item_total: z.string(),
- ship_total: z.string(),
- display_ship_total: z.string(),
adjustment_total: z.string(),
display_adjustment_total: z.string(),
promo_total: z.string(),
@@ -35,9 +31,13 @@ export const OrderSchema = z.object({
completed_at: z.string().nullable(),
created_at: z.string(),
updated_at: z.string(),
+ fulfillment_status: z.string().nullable(),
+ payment_status: z.string().nullable(),
+ delivery_total: z.string(),
+ display_delivery_total: z.string(),
promotions: z.array(OrderPromotionSchema),
items: z.array(LineItemSchema),
- shipments: z.array(ShipmentSchema),
+ fulfillments: z.array(FulfillmentSchema),
payments: z.array(PaymentSchema),
bill_address: AddressSchema.nullable(),
ship_address: AddressSchema.nullable(),
diff --git a/packages/sdk/src/zod/generated/Payment.ts b/packages/sdk/src/zod/generated/Payment.ts
index b117435937..2291dcf4e4 100644
--- a/packages/sdk/src/zod/generated/Payment.ts
+++ b/packages/sdk/src/zod/generated/Payment.ts
@@ -5,13 +5,13 @@ import { PaymentMethodSchema } from './PaymentMethod';
export const PaymentSchema = z.object({
id: z.string(),
payment_method_id: z.string(),
- state: z.string(),
response_code: z.string().nullable(),
number: z.string(),
amount: z.string(),
display_amount: z.string(),
created_at: z.string(),
updated_at: z.string(),
+ status: z.string(),
source_type: z.string().nullable(),
source_id: z.string().nullable(),
source: z.any(),
diff --git a/packages/sdk/src/zod/generated/Product.ts b/packages/sdk/src/zod/generated/Product.ts
index 393652f8be..5571a05305 100644
--- a/packages/sdk/src/zod/generated/Product.ts
+++ b/packages/sdk/src/zod/generated/Product.ts
@@ -31,7 +31,6 @@ export const ProductSchema = z.object({
media: z.array(MediaSchema).optional(),
variants: z.array(VariantSchema).optional(),
default_variant: VariantSchema.optional(),
- master_variant: VariantSchema.optional(),
option_types: z.array(OptionTypeSchema).optional(),
categories: z.array(z.lazy(() => CategorySchema)).optional(),
metafields: z.array(MetafieldSchema).optional(),
diff --git a/packages/sdk/src/zod/generated/Shipment.ts b/packages/sdk/src/zod/generated/Shipment.ts
deleted file mode 100644
index 399cd0664d..0000000000
--- a/packages/sdk/src/zod/generated/Shipment.ts
+++ /dev/null
@@ -1,23 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-import { ShippingMethodSchema } from './ShippingMethod';
-import { ShippingRateSchema } from './ShippingRate';
-import { StockLocationSchema } from './StockLocation';
-
-export const ShipmentSchema = z.object({
- id: z.string(),
- number: z.string(),
- state: z.string(),
- tracking: z.string().nullable(),
- tracking_url: z.string().nullable(),
- cost: z.string(),
- display_cost: z.string(),
- shipped_at: z.string().nullable(),
- created_at: z.string(),
- updated_at: z.string(),
- shipping_method: ShippingMethodSchema,
- stock_location: StockLocationSchema,
- shipping_rates: z.array(ShippingRateSchema),
-});
-
-export type Shipment = z.infer<typeof ShipmentSchema>;
diff --git a/packages/sdk/src/zod/generated/ShippingRate.ts b/packages/sdk/src/zod/generated/ShippingRate.ts
deleted file mode 100644
index 07abb19d7f..0000000000
--- a/packages/sdk/src/zod/generated/ShippingRate.ts
+++ /dev/null
@@ -1,15 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-import { ShippingMethodSchema } from './ShippingMethod';
-
-export const ShippingRateSchema = z.object({
- id: z.string(),
- shipping_method_id: z.string(),
- name: z.string(),
- selected: z.boolean(),
- cost: z.string(),
- display_cost: z.string(),
- shipping_method: ShippingMethodSchema,
-});
-
-export type ShippingRate = z.infer<typeof ShippingRateSchema>;
diff --git a/packages/sdk/src/zod/generated/Variant.ts b/packages/sdk/src/zod/generated/Variant.ts
index 67be7b540f..ec17cb482a 100644
--- a/packages/sdk/src/zod/generated/Variant.ts
+++ b/packages/sdk/src/zod/generated/Variant.ts
@@ -9,7 +9,6 @@ export const VariantSchema = z.object({
id: z.string(),
product_id: z.string(),
sku: z.string().nullable(),
- is_master: z.boolean(),
options_text: z.string(),
track_inventory: z.boolean(),
media_count: z.number(),
diff --git a/packages/sdk/src/zod/generated/index.ts b/packages/sdk/src/zod/generated/index.ts
index 6411339754..f03ef21576 100644
--- a/packages/sdk/src/zod/generated/index.ts
+++ b/packages/sdk/src/zod/generated/index.ts
@@ -10,9 +10,12 @@ export { CreditCardSchema, type CreditCard } from './CreditCard';
export { CurrencySchema, type Currency } from './Currency';
export { CustomerSchema, type Customer } from './Customer';
export { CustomerReturnSchema, type CustomerReturn } from './CustomerReturn';
+export { DeliveryMethodSchema, type DeliveryMethod } from './DeliveryMethod';
+export { DeliveryRateSchema, type DeliveryRate } from './DeliveryRate';
export { DigitalSchema, type Digital } from './Digital';
export { DigitalLinkSchema, type DigitalLink } from './DigitalLink';
export { ExportSchema, type Export } from './Export';
+export { FulfillmentSchema, type Fulfillment } from './Fulfillment';
export { GiftCardSchema, type GiftCard } from './GiftCard';
export { GiftCardBatchSchema, type GiftCardBatch } from './GiftCardBatch';
export { ImportSchema, type Import } from './Import';
@@ -41,10 +44,7 @@ export { ReimbursementSchema, type Reimbursement } from './Reimbursement';
export { ReportSchema, type Report } from './Report';
export { ReturnAuthorizationSchema, type ReturnAuthorization } from './ReturnAuthorization';
export { ReturnItemSchema, type ReturnItem } from './ReturnItem';
-export { ShipmentSchema, type Shipment } from './Shipment';
export { ShippingCategorySchema, type ShippingCategory } from './ShippingCategory';
-export { ShippingMethodSchema, type ShippingMethod } from './ShippingMethod';
-export { ShippingRateSchema, type ShippingRate } from './ShippingRate';
export { StateSchema, type State } from './State';
export { StockItemSchema, type StockItem } from './StockItem';
export { StockLocationSchema, type StockLocation } from './StockLocation';
diff --git a/packages/sdk/tests/cart.test.ts b/packages/sdk/tests/cart.test.ts
index 5eddcd81b6..5f65bfcf30 100644
--- a/packages/sdk/tests/cart.test.ts
+++ b/packages/sdk/tests/cart.test.ts
@@ -112,17 +112,17 @@ describe('carts', () => {
});
});
- describe('shipments', () => {
- it('lists shipments', async () => {
- const result = await client.carts.shipments.list('cart_1', opts);
+ describe('fulfillments', () => {
+ it('lists fulfillments', async () => {
+ const result = await client.carts.fulfillments.list('cart_1', opts);
expect(result.data).toBeDefined();
});
- it('selects a shipping rate', async () => {
- const result = await client.carts.shipments.update(
+ it('selects a delivery rate', async () => {
+ const result = await client.carts.fulfillments.update(
'cart_1',
- 'ship_1',
- { selected_shipping_rate_id: 'rate_1' },
+ 'ful_1',
+ { selected_delivery_rate_id: 'rate_1' },
opts
);
expect(result.id).toBe('cart_1');
diff --git a/packages/sdk/tests/mocks/handlers.ts b/packages/sdk/tests/mocks/handlers.ts
index 67a7bfe24d..b0a33ae465 100644
--- a/packages/sdk/tests/mocks/handlers.ts
+++ b/packages/sdk/tests/mocks/handlers.ts
@@ -33,8 +33,8 @@ export const fixtures = {
total: '0.00',
item_total: '0.00',
completed_at: '2026-03-01T00:00:00.000Z',
- shipment_state: 'shipped',
- payment_state: 'paid',
+ fulfillment_status: 'shipped',
+ payment_status: 'paid',
items: [],
},
lineItem: {
@@ -247,12 +247,12 @@ export const handlers = [
HttpResponse.json(fixtures.cart)
),
- // Carts > Shipments
- http.get(`${API_PREFIX}/carts/:cartId/shipments`, () =>
+ // Carts > Fulfillments
+ http.get(`${API_PREFIX}/carts/:cartId/fulfillments`, () =>
HttpResponse.json({ data: [], meta: { count: 0 } })
),
- http.patch(`${API_PREFIX}/carts/:cartId/shipments/:id`, () =>
+ http.patch(`${API_PREFIX}/carts/:cartId/fulfillments/:id`, () =>
HttpResponse.json(fixtures.cart)
),
diff --git a/spree/api/app/controllers/spree/api/v3/store/carts/shipments_controller.rb b/spree/api/app/controllers/spree/api/v3/store/carts/fulfillments_controller.rb
similarity index 57%
rename from spree/api/app/controllers/spree/api/v3/store/carts/shipments_controller.rb
rename to spree/api/app/controllers/spree/api/v3/store/carts/fulfillments_controller.rb
index 8665f3da7d..fd32e1b085 100644
--- a/spree/api/app/controllers/spree/api/v3/store/carts/shipments_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/store/carts/fulfillments_controller.rb
@@ -3,31 +3,31 @@ module Spree
module V3
module Store
module Carts
- class ShipmentsController < Store::BaseController
+ class FulfillmentsController < Store::BaseController
include Spree::Api::V3::CartResolvable
include Spree::Api::V3::OrderLock
before_action :find_cart!
- # GET /api/v3/store/carts/:cart_id/shipments
+ # GET /api/v3/store/carts/:cart_id/fulfillments
def index
- shipments = @cart.shipments.includes(shipping_rates: :shipping_method)
+ fulfillments = @cart.shipments.includes(shipping_rates: :shipping_method)
render json: {
- data: shipments.map { |s| Spree.api.shipment_serializer.new(s, params: serializer_params).to_h },
- meta: { count: shipments.size }
+ data: fulfillments.map { |s| Spree.api.fulfillment_serializer.new(s, params: serializer_params).to_h },
+ meta: { count: fulfillments.size }
}
end
- # PATCH /api/v3/store/carts/:cart_id/shipments/:id
- # Select a shipping rate for a specific shipment
+ # PATCH /api/v3/store/carts/:cart_id/fulfillments/:id
+ # Select a delivery rate for a specific fulfillment
def update
with_order_lock do
- shipment = @cart.shipments.find_by_prefix_id!(params[:id])
+ fulfillment = @cart.shipments.find_by_prefix_id!(params[:id])
- if permitted_params[:selected_shipping_rate_id].present?
- shipping_rate = shipment.shipping_rates.find_by_prefix_id!(permitted_params[:selected_shipping_rate_id])
- shipment.selected_shipping_rate_id = shipping_rate.id
- shipment.save!
+ if permitted_params[:selected_delivery_rate_id].present?
+ delivery_rate = fulfillment.shipping_rates.find_by_prefix_id!(permitted_params[:selected_delivery_rate_id])
+ fulfillment.selected_shipping_rate_id = delivery_rate.id
+ fulfillment.save!
end
# Auto-advance (e.g. delivery → payment) after rate selection.
@@ -41,7 +41,7 @@ module Spree
private
def permitted_params
- params.permit(:selected_shipping_rate_id)
+ params.permit(:selected_delivery_rate_id)
end
# Temporary — Spree 6 removes the checkout state machine.
diff --git a/spree/api/app/serializers/spree/api/v3/admin/address_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/address_serializer.rb
index 0a0dc4f5b7..13bb166fc2 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/address_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/address_serializer.rb
@@ -4,13 +4,13 @@ module Spree
module Admin
class AddressSerializer < V3::AddressSerializer
typelize label: [:string, nullable: true],
- user_id: [:string, nullable: true],
+ customer_id: [:string, nullable: true],
metadata: 'Record<string, unknown> | null'
attributes :label,
created_at: :iso8601, updated_at: :iso8601
- attribute :user_id do |address|
+ attribute :customer_id do |address|
address.user&.prefixed_id
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/credit_card_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/credit_card_serializer.rb
index e11baa31e9..ebadc8faf9 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/credit_card_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/credit_card_serializer.rb
@@ -3,10 +3,10 @@ module Spree
module V3
module Admin
class CreditCardSerializer < V3::CreditCardSerializer
- typelize user_id: [:string, nullable: true],
+ typelize customer_id: [:string, nullable: true],
payment_method_id: [:string, nullable: true]
- attribute :user_id do |credit_card|
+ attribute :customer_id do |credit_card|
credit_card.user&.prefixed_id
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/shipping_method_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/delivery_method_serializer.rb
similarity index 72%
rename from spree/api/app/serializers/spree/api/v3/admin/shipping_method_serializer.rb
rename to spree/api/app/serializers/spree/api/v3/admin/delivery_method_serializer.rb
index 8d728b302a..d3d91fa17e 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/shipping_method_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/delivery_method_serializer.rb
@@ -2,7 +2,7 @@ module Spree
module Api
module V3
module Admin
- class ShippingMethodSerializer < V3::ShippingMethodSerializer
+ class DeliveryMethodSerializer < V3::DeliveryMethodSerializer
attributes created_at: :iso8601, updated_at: :iso8601
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/delivery_rate_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/delivery_rate_serializer.rb
new file mode 100644
index 0000000000..c0149d2a60
--- /dev/null
+++ b/spree/api/app/serializers/spree/api/v3/admin/delivery_rate_serializer.rb
@@ -0,0 +1,11 @@
+module Spree
+ module Api
+ module V3
+ module Admin
+ class DeliveryRateSerializer < V3::DeliveryRateSerializer
+ one :shipping_method, key: :delivery_method, resource: Spree.api.admin_delivery_method_serializer, if: proc { expand?('delivery_method') }
+ end
+ end
+ end
+ end
+end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/shipment_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb
similarity index 79%
rename from spree/api/app/serializers/spree/api/v3/admin/shipment_serializer.rb
rename to spree/api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb
index dd6271d65b..69024490b0 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/shipment_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb
@@ -2,7 +2,7 @@ module Spree
module Api
module V3
module Admin
- class ShipmentSerializer < V3::ShipmentSerializer
+ class FulfillmentSerializer < V3::FulfillmentSerializer
typelize metadata: 'Record<string, unknown> | null',
order_id: [:string, nullable: true],
stock_location_id: [:string, nullable: true],
@@ -26,9 +26,9 @@ module Spree
end
# Override inherited associations to use admin serializers
- one :shipping_method, resource: Spree.api.admin_shipping_method_serializer, if: proc { expand?('shipping_method') }
+ one :shipping_method, key: :delivery_method, resource: Spree.api.admin_delivery_method_serializer, if: proc { expand?('delivery_method') }
one :stock_location, resource: Spree.api.admin_stock_location_serializer, if: proc { expand?('stock_location') }
- many :shipping_rates, resource: Spree.api.admin_shipping_rate_serializer, if: proc { expand?('shipping_rates') }
+ many :shipping_rates, key: :delivery_rates, resource: Spree.api.admin_delivery_rate_serializer, if: proc { expand?('delivery_rates') }
one :order,
resource: Spree.api.admin_order_serializer,
diff --git a/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb
index ba44652bcf..e321ac514a 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb
@@ -11,7 +11,7 @@ module Spree
store_owner_notification_delivered: :boolean,
internal_note: [:string, nullable: true], approver_id: [:string, nullable: true],
canceler_id: [:string, nullable: true], created_by_id: [:string, nullable: true],
- user_id: [:string, nullable: true],
+ customer_id: [:string, nullable: true],
canceled_at: [:string, nullable: true], approved_at: [:string, nullable: true],
payment_total: :string, display_payment_total: :string,
metadata: 'Record<string, unknown> | null'
@@ -38,14 +38,14 @@ module Spree
order.created_by&.prefixed_id
end
- attribute :user_id do |order|
+ attribute :customer_id do |order|
order.user&.prefixed_id
end
# Override inherited associations to use admin serializers
many :order_promotions, key: :promotions, resource: Spree.api.admin_order_promotion_serializer, if: proc { expand?('promotions') }
many :line_items, key: :items, resource: Spree.api.admin_line_item_serializer, if: proc { expand?('items') }
- many :shipments, resource: Spree.api.admin_shipment_serializer, if: proc { expand?('shipments') }
+ many :shipments, key: :fulfillments, resource: Spree.api.admin_fulfillment_serializer, if: proc { expand?('fulfillments') }
many :payments, resource: Spree.api.admin_payment_serializer, if: proc { expand?('payments') }
one :bill_address, resource: Spree.api.admin_address_serializer, if: proc { expand?('bill_address') }
@@ -54,8 +54,9 @@ module Spree
many :payment_methods, resource: Spree.api.admin_payment_method_serializer, if: proc { expand?('payment_methods') }
one :user,
+ key: :customer,
resource: Spree.api.admin_customer_serializer,
- if: proc { expand?('user') }
+ if: proc { expand?('customer') }
one :approver,
resource: Spree.api.admin_customer_serializer,
diff --git a/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb
index f158c57ae9..3333308ad2 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb
@@ -32,11 +32,6 @@ module Spree
resource: Spree.api.admin_variant_serializer,
if: proc { expand?('default_variant') }
- one :master,
- key: :master_variant,
- resource: Spree.api.admin_variant_serializer,
- if: proc { expand?('master_variant') }
-
one :primary_media,
resource: Spree.api.admin_media_serializer,
if: proc { expand?('primary_media') }
diff --git a/spree/api/app/serializers/spree/api/v3/admin/shipping_rate_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/shipping_rate_serializer.rb
deleted file mode 100644
index afeaeadfcb..0000000000
--- a/spree/api/app/serializers/spree/api/v3/admin/shipping_rate_serializer.rb
+++ /dev/null
@@ -1,11 +0,0 @@
-module Spree
- module Api
- module V3
- module Admin
- class ShippingRateSerializer < V3::ShippingRateSerializer
- one :shipping_method, resource: Spree.api.admin_shipping_method_serializer, if: proc { expand?('shipping_method') }
- end
- end
- end
- end
-end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb
index 63addc270d..e8eb1b2fe5 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb
@@ -3,11 +3,11 @@ module Spree
module V3
module Admin
class StoreCreditSerializer < V3::StoreCreditSerializer
- typelize user_id: [:string, nullable: true],
+ typelize customer_id: [:string, nullable: true],
created_by_id: [:string, nullable: true],
metadata: 'Record<string, unknown> | null'
- attribute :user_id do |store_credit|
+ attribute :customer_id do |store_credit|
store_credit.user&.prefixed_id
end
diff --git a/spree/api/app/serializers/spree/api/v3/cart_serializer.rb b/spree/api/app/serializers/spree/api/v3/cart_serializer.rb
index 0d2013d540..b9425f611f 100644
--- a/spree/api/app/serializers/spree/api/v3/cart_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/cart_serializer.rb
@@ -8,7 +8,7 @@ module Spree
special_instructions: [:string, nullable: true], currency: :string, locale: [:string, nullable: true], item_count: :number,
requirements: 'Array<{step: string, field: string, message: string}>',
item_total: :string, display_item_total: :string,
- ship_total: :string, display_ship_total: :string,
+ delivery_total: :string, display_delivery_total: :string,
adjustment_total: :string, display_adjustment_total: :string,
promo_total: :string, display_promo_total: :string,
tax_total: :string, display_tax_total: :string,
@@ -24,12 +24,20 @@ module Spree
attributes :number, :token, :email, :special_instructions,
:currency, :locale, :item_count,
- :item_total, :display_item_total, :ship_total, :display_ship_total,
+ :item_total, :display_item_total,
:adjustment_total, :display_adjustment_total, :promo_total, :display_promo_total,
:tax_total, :display_tax_total, :included_tax_total, :display_included_tax_total,
:additional_tax_total, :display_additional_tax_total, :total, :display_total,
created_at: :iso8601, updated_at: :iso8601
+ attribute :delivery_total do |order|
+ order.ship_total
+ end
+
+ attribute :display_delivery_total do |order|
+ order.display_ship_total.to_s
+ end
+
attribute :current_step do |order|
order.current_checkout_step
end
@@ -44,7 +52,7 @@ module Spree
many :cart_promotions, key: :promotions, resource: Spree.api.cart_promotion_serializer
many :line_items, key: :items, resource: Spree.api.line_item_serializer
- many :shipments, resource: Spree.api.shipment_serializer
+ many :shipments, key: :fulfillments, resource: Spree.api.fulfillment_serializer
many :payments, resource: Spree.api.payment_serializer
one :bill_address, resource: Spree.api.address_serializer
one :ship_address, resource: Spree.api.address_serializer
diff --git a/spree/api/app/serializers/spree/api/v3/shipping_method_serializer.rb b/spree/api/app/serializers/spree/api/v3/delivery_method_serializer.rb
similarity index 75%
rename from spree/api/app/serializers/spree/api/v3/shipping_method_serializer.rb
rename to spree/api/app/serializers/spree/api/v3/delivery_method_serializer.rb
index 869af6df49..055e223eb0 100644
--- a/spree/api/app/serializers/spree/api/v3/shipping_method_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/delivery_method_serializer.rb
@@ -1,7 +1,7 @@
module Spree
module Api
module V3
- class ShippingMethodSerializer < BaseSerializer
+ class DeliveryMethodSerializer < BaseSerializer
typelize name: :string, code: [:string, nullable: true]
attributes :name, :code
diff --git a/spree/api/app/serializers/spree/api/v3/shipping_rate_serializer.rb b/spree/api/app/serializers/spree/api/v3/delivery_rate_serializer.rb
similarity index 56%
rename from spree/api/app/serializers/spree/api/v3/shipping_rate_serializer.rb
rename to spree/api/app/serializers/spree/api/v3/delivery_rate_serializer.rb
index 4aff2764bd..110b3ae2e4 100644
--- a/spree/api/app/serializers/spree/api/v3/shipping_rate_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/delivery_rate_serializer.rb
@@ -1,11 +1,11 @@
module Spree
module Api
module V3
- class ShippingRateSerializer < BaseSerializer
- typelize name: :string, selected: :boolean, shipping_method_id: :string,
+ class DeliveryRateSerializer < BaseSerializer
+ typelize name: :string, selected: :boolean, delivery_method_id: :string,
cost: :string, display_cost: :string
- attribute :shipping_method_id do |shipping_rate|
+ attribute :delivery_method_id do |shipping_rate|
shipping_rate.shipping_method&.prefixed_id
end
@@ -15,7 +15,7 @@ module Spree
shipping_rate.display_cost.to_s
end
- one :shipping_method, resource: Spree.api.shipping_method_serializer
+ one :shipping_method, key: :delivery_method, resource: Spree.api.delivery_method_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/fulfillment_serializer.rb b/spree/api/app/serializers/spree/api/v3/fulfillment_serializer.rb
new file mode 100644
index 0000000000..6a9dd2dc0e
--- /dev/null
+++ b/spree/api/app/serializers/spree/api/v3/fulfillment_serializer.rb
@@ -0,0 +1,32 @@
+module Spree
+ module Api
+ module V3
+ class FulfillmentSerializer < BaseSerializer
+ typelize number: :string, status: :string, fulfillment_type: :string,
+ tracking: [:string, nullable: true],
+ tracking_url: [:string, nullable: true], fulfilled_at: [:string, nullable: true],
+ cost: :string, display_cost: :string
+
+ attributes :number, :tracking, :tracking_url,
+ :cost, :display_cost,
+ created_at: :iso8601, updated_at: :iso8601
+
+ attribute :status do |shipment|
+ shipment.state
+ end
+
+ attribute :fulfillment_type do |shipment|
+ shipment.digital? ? 'digital' : 'shipping'
+ end
+
+ attribute :fulfilled_at do |shipment|
+ shipment.shipped_at&.iso8601
+ end
+
+ one :shipping_method, key: :delivery_method, resource: Spree.api.delivery_method_serializer
+ one :stock_location, resource: Spree.api.stock_location_serializer
+ many :shipping_rates, key: :delivery_rates, resource: Spree.api.delivery_rate_serializer
+ end
+ end
+ end
+end
diff --git a/spree/api/app/serializers/spree/api/v3/gift_card_serializer.rb b/spree/api/app/serializers/spree/api/v3/gift_card_serializer.rb
index b8ff29064b..cd4fa994e2 100644
--- a/spree/api/app/serializers/spree/api/v3/gift_card_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/gift_card_serializer.rb
@@ -3,7 +3,7 @@ module Spree
module V3
class GiftCardSerializer < BaseSerializer
typelize code: :string,
- state: :string,
+ status: :string,
amount: :string,
amount_used: :string,
amount_authorized: :string,
@@ -21,7 +21,7 @@ module Spree
gift_card.display_code
end
- attribute :state do |gift_card|
+ attribute :status do |gift_card|
gift_card.display_state
end
diff --git a/spree/api/app/serializers/spree/api/v3/newsletter_subscriber_serializer.rb b/spree/api/app/serializers/spree/api/v3/newsletter_subscriber_serializer.rb
index 84fb064a06..84d315f120 100644
--- a/spree/api/app/serializers/spree/api/v3/newsletter_subscriber_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/newsletter_subscriber_serializer.rb
@@ -6,7 +6,7 @@ module Spree
class NewsletterSubscriberSerializer < BaseSerializer
typelize email: :string, verified: :boolean,
verified_at: [:string, nullable: true],
- user_id: [:string, nullable: true]
+ customer_id: [:string, nullable: true]
attributes :email, created_at: :iso8601, updated_at: :iso8601
@@ -18,7 +18,7 @@ module Spree
subscriber.verified_at&.iso8601
end
- attribute :user_id do |subscriber|
+ attribute :customer_id do |subscriber|
subscriber.user&.prefixed_id
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/order_serializer.rb b/spree/api/app/serializers/spree/api/v3/order_serializer.rb
index 859669a207..39fccd592b 100644
--- a/spree/api/app/serializers/spree/api/v3/order_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/order_serializer.rb
@@ -6,9 +6,9 @@ module Spree
class OrderSerializer < BaseSerializer
typelize number: :string, email: :string,
special_instructions: [:string, nullable: true], currency: :string, locale: [:string, nullable: true], item_count: :number,
- shipment_state: [:string, nullable: true], payment_state: [:string, nullable: true],
+ fulfillment_status: [:string, nullable: true], payment_status: [:string, nullable: true],
item_total: :string, display_item_total: :string,
- ship_total: :string, display_ship_total: :string,
+ delivery_total: :string, display_delivery_total: :string,
adjustment_total: :string, display_adjustment_total: :string,
promo_total: :string, display_promo_total: :string,
tax_total: :string, display_tax_total: :string,
@@ -18,16 +18,32 @@ module Spree
bill_address: { nullable: true }, ship_address: { nullable: true }
attributes :number, :email, :special_instructions,
- :currency, :locale, :item_count, :shipment_state, :payment_state,
- :item_total, :display_item_total, :ship_total, :display_ship_total,
+ :currency, :locale, :item_count,
+ :item_total, :display_item_total,
:adjustment_total, :display_adjustment_total, :promo_total, :display_promo_total,
:tax_total, :display_tax_total, :included_tax_total, :display_included_tax_total,
:additional_tax_total, :display_additional_tax_total, :total, :display_total,
completed_at: :iso8601, created_at: :iso8601, updated_at: :iso8601
+ attribute :fulfillment_status do |order|
+ order.shipment_state
+ end
+
+ attribute :payment_status do |order|
+ order.payment_state
+ end
+
+ attribute :delivery_total do |order|
+ order.ship_total
+ end
+
+ attribute :display_delivery_total do |order|
+ order.display_ship_total.to_s
+ end
+
many :order_promotions, key: :promotions, resource: Spree.api.order_promotion_serializer
many :line_items, key: :items, resource: Spree.api.line_item_serializer
- many :shipments, resource: Spree.api.shipment_serializer
+ many :shipments, key: :fulfillments, resource: Spree.api.fulfillment_serializer
many :payments, resource: Spree.api.payment_serializer
one :bill_address, resource: Spree.api.address_serializer
one :ship_address, resource: Spree.api.address_serializer
diff --git a/spree/api/app/serializers/spree/api/v3/payment_serializer.rb b/spree/api/app/serializers/spree/api/v3/payment_serializer.rb
index e271cf2788..8eebdd1f12 100644
--- a/spree/api/app/serializers/spree/api/v3/payment_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/payment_serializer.rb
@@ -2,7 +2,7 @@ module Spree
module Api
module V3
class PaymentSerializer < BaseSerializer
- typelize state: :string, payment_method_id: :string, response_code: [:string, nullable: true],
+ typelize status: :string, payment_method_id: :string, response_code: [:string, nullable: true],
number: :string, amount: :string, display_amount: :string,
source_type: [:string, nullable: true, enum: %w[credit_card store_credit payment_source]],
source_id: [:string, nullable: true],
@@ -12,9 +12,13 @@ module Spree
payment.payment_method&.prefixed_id
end
- attributes :state, :response_code, :number, :amount, :display_amount,
+ attributes :response_code, :number, :amount, :display_amount,
created_at: :iso8601, updated_at: :iso8601
+ attribute :status do |payment|
+ payment.state
+ end
+
attribute :source_type do |payment|
case payment.source_type
when 'Spree::CreditCard'
diff --git a/spree/api/app/serializers/spree/api/v3/product_serializer.rb b/spree/api/app/serializers/spree/api/v3/product_serializer.rb
index 65cdf9cace..53f530baf9 100644
--- a/spree/api/app/serializers/spree/api/v3/product_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/product_serializer.rb
@@ -85,11 +85,6 @@ module Spree
resource: Spree.api.variant_serializer,
if: proc { expand?('default_variant') }
- one :master,
- key: :master_variant,
- resource: Spree.api.variant_serializer,
- if: proc { expand?('master_variant') }
-
many :option_types,
resource: Spree.api.option_type_serializer,
if: proc { expand?('option_types') }
diff --git a/spree/api/app/serializers/spree/api/v3/shipment_serializer.rb b/spree/api/app/serializers/spree/api/v3/shipment_serializer.rb
deleted file mode 100644
index fb37f88620..0000000000
--- a/spree/api/app/serializers/spree/api/v3/shipment_serializer.rb
+++ /dev/null
@@ -1,19 +0,0 @@
-module Spree
- module Api
- module V3
- class ShipmentSerializer < BaseSerializer
- typelize number: :string, state: :string, tracking: [:string, nullable: true],
- tracking_url: [:string, nullable: true], shipped_at: [:string, nullable: true],
- cost: :string, display_cost: :string
-
- attributes :number, :state, :tracking, :tracking_url,
- :cost, :display_cost,
- shipped_at: :iso8601, created_at: :iso8601, updated_at: :iso8601
-
- one :shipping_method, resource: Spree.api.shipping_method_serializer
- one :stock_location, resource: Spree.api.stock_location_serializer
- many :shipping_rates, resource: Spree.api.shipping_rate_serializer
- end
- end
- end
-end
diff --git a/spree/api/app/serializers/spree/api/v3/variant_serializer.rb b/spree/api/app/serializers/spree/api/v3/variant_serializer.rb
index 24c492f6e3..7399b60a27 100644
--- a/spree/api/app/serializers/spree/api/v3/variant_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/variant_serializer.rb
@@ -5,7 +5,7 @@ module Spree
# Customer-facing variant data with limited fields
class VariantSerializer < BaseSerializer
typelize product_id: :string, sku: [:string, nullable: true],
- is_master: :boolean, options_text: :string, track_inventory: :boolean, media_count: :number,
+ options_text: :string, track_inventory: :boolean, media_count: :number,
thumbnail_url: [:string, nullable: true],
purchasable: :boolean, in_stock: :boolean, backorderable: :boolean,
weight: [:number, nullable: true], height: [:number, nullable: true], width: [:number, nullable: true], depth: [:number, nullable: true],
@@ -16,7 +16,7 @@ module Spree
variant.product&.prefixed_id
end
- attributes :sku, :is_master, :options_text, :track_inventory, :media_count,
+ attributes :sku, :options_text, :track_inventory, :media_count,
created_at: :iso8601, updated_at: :iso8601
# Main variant image URL for listings (cached primary_media)
diff --git a/spree/api/config/routes.rb b/spree/api/config/routes.rb
index 92de8652b1..edf7fbb6d0 100644
--- a/spree/api/config/routes.rb
+++ b/spree/api/config/routes.rb
@@ -38,7 +38,7 @@ Spree::Core::Engine.add_routes do
end
resources :items, only: [:create, :update, :destroy], controller: 'carts/items'
resources :coupon_codes, only: [:create, :destroy], controller: 'carts/coupon_codes'
- resources :shipments, only: [:index, :update], controller: 'carts/shipments'
+ resources :fulfillments, only: [:index, :update], controller: 'carts/fulfillments'
resources :payment_methods, only: [:index], controller: 'carts/payment_methods'
resources :payments, only: [:index, :show, :create], controller: 'carts/payments'
resources :payment_sessions, only: [:create, :show, :update], controller: 'carts/payment_sessions' do
diff --git a/spree/api/lib/spree/api/dependencies.rb b/spree/api/lib/spree/api/dependencies.rb
index ef18a29c9f..3705e60921 100644
--- a/spree/api/lib/spree/api/dependencies.rb
+++ b/spree/api/lib/spree/api/dependencies.rb
@@ -107,7 +107,8 @@ module Spree
payment_setup_session_serializer: 'Spree::Api::V3::PaymentSetupSessionSerializer',
payment_source_serializer: 'Spree::Api::V3::PaymentSourceSerializer',
store_credit_serializer: 'Spree::Api::V3::StoreCreditSerializer',
- shipment_serializer: 'Spree::Api::V3::ShipmentSerializer',
+ shipment_serializer: 'Spree::Api::V3::FulfillmentSerializer',
+ fulfillment_serializer: 'Spree::Api::V3::FulfillmentSerializer',
address_serializer: 'Spree::Api::V3::AddressSerializer',
customer_serializer: 'Spree::Api::V3::CustomerSerializer',
country_serializer: 'Spree::Api::V3::CountrySerializer',
@@ -116,8 +117,10 @@ module Spree
wishlist_serializer: 'Spree::Api::V3::WishlistSerializer',
wished_item_serializer: 'Spree::Api::V3::WishedItemSerializer',
payment_method_serializer: 'Spree::Api::V3::PaymentMethodSerializer',
- shipping_method_serializer: 'Spree::Api::V3::ShippingMethodSerializer',
- shipping_rate_serializer: 'Spree::Api::V3::ShippingRateSerializer',
+ shipping_method_serializer: 'Spree::Api::V3::DeliveryMethodSerializer',
+ shipping_rate_serializer: 'Spree::Api::V3::DeliveryRateSerializer',
+ delivery_method_serializer: 'Spree::Api::V3::DeliveryMethodSerializer',
+ delivery_rate_serializer: 'Spree::Api::V3::DeliveryRateSerializer',
stock_location_serializer: 'Spree::Api::V3::StockLocationSerializer',
category_serializer: 'Spree::Api::V3::CategorySerializer',
cart_promotion_serializer: 'Spree::Api::V3::CartPromotionSerializer',
@@ -164,7 +167,8 @@ module Spree
admin_media_serializer: 'Spree::Api::V3::Admin::MediaSerializer',
admin_asset_serializer: 'Spree::Api::V3::Admin::AssetSerializer',
admin_stock_item_serializer: 'Spree::Api::V3::Admin::StockItemSerializer',
- admin_shipment_serializer: 'Spree::Api::V3::Admin::ShipmentSerializer',
+ admin_shipment_serializer: 'Spree::Api::V3::Admin::FulfillmentSerializer',
+ admin_fulfillment_serializer: 'Spree::Api::V3::Admin::FulfillmentSerializer',
admin_payment_serializer: 'Spree::Api::V3::Admin::PaymentSerializer',
admin_refund_serializer: 'Spree::Api::V3::Admin::RefundSerializer',
admin_adjustment_serializer: 'Spree::Api::V3::Admin::AdjustmentSerializer',
@@ -174,9 +178,11 @@ module Spree
admin_reimbursement_serializer: 'Spree::Api::V3::Admin::ReimbursementSerializer',
admin_admin_user_serializer: 'Spree::Api::V3::Admin::AdminUserSerializer',
admin_address_serializer: 'Spree::Api::V3::Admin::AddressSerializer',
- admin_shipping_method_serializer: 'Spree::Api::V3::Admin::ShippingMethodSerializer',
+ admin_shipping_method_serializer: 'Spree::Api::V3::Admin::DeliveryMethodSerializer',
+ admin_delivery_method_serializer: 'Spree::Api::V3::Admin::DeliveryMethodSerializer',
admin_stock_location_serializer: 'Spree::Api::V3::Admin::StockLocationSerializer',
- admin_shipping_rate_serializer: 'Spree::Api::V3::Admin::ShippingRateSerializer',
+ admin_shipping_rate_serializer: 'Spree::Api::V3::Admin::DeliveryRateSerializer',
+ admin_delivery_rate_serializer: 'Spree::Api::V3::Admin::DeliveryRateSerializer',
admin_order_promotion_serializer: 'Spree::Api::V3::Admin::OrderPromotionSerializer',
admin_payment_method_serializer: 'Spree::Api::V3::Admin::PaymentMethodSerializer',
admin_credit_card_serializer: 'Spree::Api::V3::Admin::CreditCardSerializer',
diff --git a/spree/api/spec/controllers/spree/api/v3/store/carts/shipments_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/carts/fulfillments_controller_spec.rb
similarity index 67%
rename from spree/api/spec/controllers/spree/api/v3/store/carts/shipments_controller_spec.rb
rename to spree/api/spec/controllers/spree/api/v3/store/carts/fulfillments_controller_spec.rb
index fef01f314f..88da753423 100644
--- a/spree/api/spec/controllers/spree/api/v3/store/carts/shipments_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/store/carts/fulfillments_controller_spec.rb
@@ -1,6 +1,6 @@
require 'spec_helper'
-RSpec.describe Spree::Api::V3::Store::Carts::ShipmentsController, type: :controller do
+RSpec.describe Spree::Api::V3::Store::Carts::FulfillmentsController, type: :controller do
render_views
include_context 'API v3 Store'
@@ -12,7 +12,7 @@ RSpec.describe Spree::Api::V3::Store::Carts::ShipmentsController, type: :control
o.reload
end
end
- let!(:shipment) { order.shipments.first }
+ let!(:fulfillment) { order.shipments.first }
before do
request.headers['X-Spree-Api-Key'] = api_key.token
@@ -20,12 +20,12 @@ RSpec.describe Spree::Api::V3::Store::Carts::ShipmentsController, type: :control
end
describe 'GET #index' do
- it 'returns a list of shipments for the cart' do
+ it 'returns a list of fulfillments for the cart' do
get :index, params: { cart_id: order.prefixed_id }
expect(response).to have_http_status(:ok)
expect(json_response['data'].size).to eq(order.shipments.count)
- expect(json_response['data'].first['id']).to eq(shipment.prefixed_id)
+ expect(json_response['data'].first['id']).to eq(fulfillment.prefixed_id)
end
context 'with spree token (guest)' do
@@ -38,7 +38,7 @@ RSpec.describe Spree::Api::V3::Store::Carts::ShipmentsController, type: :control
before { request.headers['Authorization'] = nil }
- it 'returns shipments with valid spree token' do
+ it 'returns fulfillments with valid spree token' do
request.headers['x-spree-token'] = guest_order.token
get :index, params: { cart_id: guest_order.prefixed_id }
@@ -55,27 +55,27 @@ RSpec.describe Spree::Api::V3::Store::Carts::ShipmentsController, type: :control
end
describe 'PATCH #update' do
- context 'when selecting a different shipping rate' do
+ context 'when selecting a different delivery rate' do
let(:cheaper_shipping_method) { create(:shipping_method, name: 'Cheap Shipping') }
let(:expensive_shipping_method) { create(:shipping_method, name: 'Express Shipping') }
before do
- shipment.shipping_rates.delete_all
- create(:shipping_rate, shipment: shipment, shipping_method: cheaper_shipping_method, cost: 5, selected: true)
- create(:shipping_rate, shipment: shipment, shipping_method: expensive_shipping_method, cost: 25, selected: false)
- shipment.reload
+ fulfillment.shipping_rates.delete_all
+ create(:shipping_rate, shipment: fulfillment, shipping_method: cheaper_shipping_method, cost: 5, selected: true)
+ create(:shipping_rate, shipment: fulfillment, shipping_method: expensive_shipping_method, cost: 25, selected: false)
+ fulfillment.reload
order.set_shipments_cost
end
- it 'updates order totals when a different shipping rate is selected' do
- expensive_rate = shipment.shipping_rates.find_by(shipping_method: expensive_shipping_method)
+ it 'updates order totals when a different delivery rate is selected' do
+ expensive_rate = fulfillment.shipping_rates.find_by(shipping_method: expensive_shipping_method)
expect(order.shipment_total).to eq(5)
patch :update, params: {
cart_id: order.prefixed_id,
- id: shipment.to_param,
- selected_shipping_rate_id: expensive_rate.to_param
+ id: fulfillment.to_param,
+ selected_delivery_rate_id: expensive_rate.to_param
}
expect(response).to have_http_status(:ok)
@@ -87,14 +87,14 @@ RSpec.describe Spree::Api::V3::Store::Carts::ShipmentsController, type: :control
context 'auto-advance after rate selection' do
it 'advances order from delivery to payment' do
- rate = shipment.shipping_rates.first
+ rate = fulfillment.shipping_rates.first
expect(order.state).to eq('delivery')
patch :update, params: {
cart_id: order.prefixed_id,
- id: shipment.to_param,
- selected_shipping_rate_id: rate.to_param
+ id: fulfillment.to_param,
+ selected_delivery_rate_id: rate.to_param
}
expect(response).to have_http_status(:ok)
@@ -104,12 +104,12 @@ RSpec.describe Spree::Api::V3::Store::Carts::ShipmentsController, type: :control
it 'does not fail if advancement is not possible' do
order.update_column(:state, 'address')
- rate = shipment.shipping_rates.first
+ rate = fulfillment.shipping_rates.first
patch :update, params: {
cart_id: order.prefixed_id,
- id: shipment.to_param,
- selected_shipping_rate_id: rate.to_param
+ id: fulfillment.to_param,
+ selected_delivery_rate_id: rate.to_param
}
expect(response).to have_http_status(:ok)
@@ -117,11 +117,11 @@ RSpec.describe Spree::Api::V3::Store::Carts::ShipmentsController, type: :control
end
context 'error handling' do
- it 'returns not found for non-existent shipping rate' do
+ it 'returns not found for non-existent delivery rate' do
patch :update, params: {
cart_id: order.prefixed_id,
- id: shipment.to_param,
- selected_shipping_rate_id: 'sr_invalid'
+ id: fulfillment.to_param,
+ selected_delivery_rate_id: 'dr_invalid'
}
expect(response).to have_http_status(:not_found)
diff --git a/spree/api/spec/controllers/spree/api/v3/store/carts/payments_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/carts/payments_controller_spec.rb
index daff0ae123..00ae8a5c68 100644
--- a/spree/api/spec/controllers/spree/api/v3/store/carts/payments_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/store/carts/payments_controller_spec.rb
@@ -57,7 +57,7 @@ RSpec.describe Spree::Api::V3::Store::Carts::PaymentsController, type: :controll
expect(response).to have_http_status(:ok)
expect(json_response['id']).to eq(payment.prefixed_id)
- expect(json_response['state']).to eq(payment.state)
+ expect(json_response['status']).to eq(payment.state)
expect(json_response['amount']).to eq(payment.amount.to_s)
end
@@ -88,7 +88,7 @@ RSpec.describe Spree::Api::V3::Store::Carts::PaymentsController, type: :controll
expect(response).to have_http_status(:created)
expect(json_response['id']).to be_present
- expect(json_response['state']).to eq('checkout')
+ expect(json_response['status']).to eq('checkout')
expect(json_response['payment_method_id']).to eq(check_payment_method.prefixed_id)
end
diff --git a/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rb
index 94537412c8..4b003298ed 100644
--- a/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rb
@@ -404,7 +404,7 @@ RSpec.describe Spree::Api::V3::Store::CartsController, type: :controller do
get :show, params: { id: cart.prefixed_id }
expect(response).to have_http_status(:ok)
- expect(json_response['shipments']).to be_present
+ expect(json_response['fulfillments']).to be_present
end
it 'does not advance when no address is set' do
@@ -415,7 +415,7 @@ RSpec.describe Spree::Api::V3::Store::CartsController, type: :controller do
get :show, params: { id: cart.prefixed_id }
expect(response).to have_http_status(:ok)
- expect(json_response['shipments']).to be_empty
+ expect(json_response['fulfillments']).to be_empty
end
end
end
diff --git a/spree/api/spec/controllers/spree/api/v3/store/customer/gift_cards_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/customer/gift_cards_controller_spec.rb
index e87f1b019f..6095e9d440 100644
--- a/spree/api/spec/controllers/spree/api/v3/store/customer/gift_cards_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/store/customer/gift_cards_controller_spec.rb
@@ -27,7 +27,7 @@ RSpec.describe Spree::Api::V3::Store::Customer::GiftCardsController, type: :cont
expect(card_data).to include(
'id',
'code',
- 'state',
+ 'status',
'amount',
'amount_used',
'amount_remaining',
@@ -99,7 +99,7 @@ RSpec.describe Spree::Api::V3::Store::Customer::GiftCardsController, type: :cont
expired_data = json_response['data'].find { |c| c['id'] == expired_card.prefixed_id }
expect(expired_data['expired']).to be true
expect(expired_data['active']).to be false
- expect(expired_data['state']).to eq('expired')
+ expect(expired_data['status']).to eq('expired')
end
end
@@ -110,7 +110,7 @@ RSpec.describe Spree::Api::V3::Store::Customer::GiftCardsController, type: :cont
get :index
partial_data = json_response['data'].find { |c| c['id'] == partial_card.prefixed_id }
- expect(partial_data['state']).to eq('partially_redeemed')
+ expect(partial_data['status']).to eq('partially_redeemed')
expect(partial_data['amount_remaining']).to eq('30.0')
end
end
diff --git a/spree/api/spec/integration/spree/api/v3/store/shipments_spec.rb b/spree/api/spec/integration/spree/api/v3/store/fulfillments_spec.rb
similarity index 64%
rename from spree/api/spec/integration/spree/api/v3/store/shipments_spec.rb
rename to spree/api/spec/integration/spree/api/v3/store/fulfillments_spec.rb
index 9441e64fbb..73fed10040 100644
--- a/spree/api/spec/integration/spree/api/v3/store/shipments_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/store/fulfillments_spec.rb
@@ -2,22 +2,22 @@
require 'swagger_helper'
-RSpec.describe 'Cart Shipments API', type: :request, swagger_doc: 'api-reference/store.yaml' do
+RSpec.describe 'Cart Fulfillments API', type: :request, swagger_doc: 'api-reference/store.yaml' do
include_context 'API v3 Store'
let!(:order) { create(:order_with_line_items, store: store, user: user, state: 'delivery') }
- let!(:shipment) { order.shipments.first }
+ let!(:fulfillment) { order.shipments.first }
let(:cart_id) { order.prefixed_id }
- path '/api/v3/store/carts/{cart_id}/shipments' do
- get 'List shipments' do
+ path '/api/v3/store/carts/{cart_id}/fulfillments' do
+ get 'List fulfillments' do
tags 'Carts'
produces 'application/json'
security [api_key: [], bearer_auth: []]
- description 'Returns all shipments with shipping rates for the cart.'
+ description 'Returns all fulfillments with delivery rates for the cart.'
sdk_example <<~JS
- const shipments = await client.carts.shipments.list('cart_abc123', {
+ const fulfillments = await client.carts.fulfillments.list('cart_abc123', {
bearerToken: '<token>',
})
JS
@@ -27,7 +27,7 @@ RSpec.describe 'Cart Shipments API', type: :request, swagger_doc: 'api-reference
parameter name: :cart_id, in: :path, type: :string, required: true, description: 'Cart prefixed ID (e.g., cart_abc123)'
parameter name: 'x-spree-token', in: :header, type: :string, required: false, description: 'Order token for guest access'
- response '200', 'shipments found' do
+ response '200', 'fulfillments found' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
@@ -40,17 +40,17 @@ RSpec.describe 'Cart Shipments API', type: :request, swagger_doc: 'api-reference
end
end
- path '/api/v3/store/carts/{cart_id}/shipments/{id}' do
- patch 'Select shipping rate for shipment' do
+ path '/api/v3/store/carts/{cart_id}/fulfillments/{id}' do
+ patch 'Select delivery rate for fulfillment' do
tags 'Carts'
consumes 'application/json'
produces 'application/json'
security [api_key: [], bearer_auth: []]
- description 'Selects a shipping rate for a specific shipment and auto-advances checkout.'
+ description 'Selects a delivery rate for a specific fulfillment and auto-advances checkout.'
sdk_example <<~JS
- const cart = await client.carts.shipments.update('cart_abc123', 'ship_abc123', {
- selected_shipping_rate_id: 'shpr_abc123',
+ const cart = await client.carts.fulfillments.update('cart_abc123', 'ful_abc123', {
+ selected_delivery_rate_id: 'dr_abc123',
}, {
bearerToken: '<token>',
})
@@ -59,22 +59,22 @@ RSpec.describe 'Cart Shipments API', type: :request, swagger_doc: 'api-reference
parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
parameter name: 'Authorization', in: :header, type: :string, required: false
parameter name: :cart_id, in: :path, type: :string, required: true, description: 'Cart prefixed ID'
- parameter name: :id, in: :path, type: :string, required: true, description: 'Shipment ID'
+ parameter name: :id, in: :path, type: :string, required: true, description: 'Fulfillment ID'
parameter name: 'x-spree-token', in: :header, type: :string, required: false, description: 'Order token for guest access'
parameter name: :body, in: :body, schema: {
type: :object,
properties: {
- selected_shipping_rate_id: { type: :string, example: 'shpr_abc123', description: 'Shipping rate ID to select' }
+ selected_delivery_rate_id: { type: :string, example: 'dr_abc123', description: 'Delivery rate ID to select' }
},
- required: %w[selected_shipping_rate_id]
+ required: %w[selected_delivery_rate_id]
}
- response '200', 'shipping rate selected, returns updated cart' do
- let(:shipping_rate) { shipment.shipping_rates.first }
+ response '200', 'delivery rate selected, returns updated cart' do
+ let(:delivery_rate) { fulfillment.shipping_rates.first }
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { shipment.to_param }
- let(:body) { { selected_shipping_rate_id: shipping_rate.to_param } }
+ let(:id) { fulfillment.to_param }
+ let(:body) { { selected_delivery_rate_id: delivery_rate.to_param } }
schema '$ref' => '#/components/schemas/Cart'
@@ -85,11 +85,11 @@ RSpec.describe 'Cart Shipments API', type: :request, swagger_doc: 'api-reference
end
end
- response '404', 'shipping rate not found' do
+ response '404', 'delivery rate not found' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { shipment.to_param }
- let(:body) { { selected_shipping_rate_id: 'shpr_invalid' } }
+ let(:id) { fulfillment.to_param }
+ let(:body) { { selected_delivery_rate_id: 'dr_invalid' } }
schema '$ref' => '#/components/schemas/ErrorResponse'
diff --git a/spree/api/spec/integration/spree/api/v3/store/gift_cards_spec.rb b/spree/api/spec/integration/spree/api/v3/store/gift_cards_spec.rb
index 352efb417f..89dd81c856 100644
--- a/spree/api/spec/integration/spree/api/v3/store/gift_cards_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/store/gift_cards_spec.rb
@@ -40,7 +40,7 @@ RSpec.describe 'Gift Cards API', type: :request, swagger_doc: 'api-reference/sto
run_test! do |response|
data = JSON.parse(response.body)
expect(data['data']).to be_an(Array)
- expect(data['data'].first).to include('id', 'code', 'amount', 'state')
+ expect(data['data'].first).to include('id', 'code', 'amount', 'status')
end
end
diff --git a/spree/api/spec/integration/spree/api/v3/store/payments_spec.rb b/spree/api/spec/integration/spree/api/v3/store/payments_spec.rb
index 0a6e3b6272..e03c22feda 100644
--- a/spree/api/spec/integration/spree/api/v3/store/payments_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/store/payments_spec.rb
@@ -84,7 +84,7 @@ RSpec.describe 'Cart Payments API', type: :request, swagger_doc: 'api-reference/
run_test! do |response|
data = JSON.parse(response.body)
- expect(data['state']).to eq('checkout')
+ expect(data['status']).to eq('checkout')
expect(data['payment_method_id']).to eq(check_method.prefixed_id)
end
end
diff --git a/spree/api/spec/serializers/spree/api/v3/gift_card_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/gift_card_serializer_spec.rb
index 2b8e4fba06..4fdb79daf6 100644
--- a/spree/api/spec/serializers/spree/api/v3/gift_card_serializer_spec.rb
+++ b/spree/api/spec/serializers/spree/api/v3/gift_card_serializer_spec.rb
@@ -9,7 +9,7 @@ RSpec.describe Spree::Api::V3::GiftCardSerializer do
it 'includes all expected attributes' do
expect(subject.keys).to match_array(%w[
- id code state currency
+ id code status currency
amount amount_used amount_authorized amount_remaining
display_amount display_amount_used display_amount_remaining
expires_at redeemed_at expired active
@@ -42,8 +42,8 @@ RSpec.describe Spree::Api::V3::GiftCardSerializer do
expect(subject['currency']).to eq(gift_card.currency)
end
- it 'returns state' do
- expect(subject['state']).to eq('active')
+ it 'returns status' do
+ expect(subject['status']).to eq('active')
end
it 'returns active as true for active card' do
@@ -64,8 +64,8 @@ RSpec.describe Spree::Api::V3::GiftCardSerializer do
context 'with expired gift card' do
let(:gift_card) { create(:gift_card, :expired, store: store, amount: 50) }
- it 'returns expired state' do
- expect(subject['state']).to eq('expired')
+ it 'returns expired status' do
+ expect(subject['status']).to eq('expired')
expect(subject['expired']).to be true
expect(subject['active']).to be false
end
@@ -78,8 +78,8 @@ RSpec.describe Spree::Api::V3::GiftCardSerializer do
context 'with redeemed gift card' do
let(:gift_card) { create(:gift_card, :redeemed, store: store, amount: 50) }
- it 'returns redeemed state' do
- expect(subject['state']).to eq('redeemed')
+ it 'returns redeemed status' do
+ expect(subject['status']).to eq('redeemed')
end
it 'returns redeemed_at as ISO 8601' do
@@ -94,8 +94,8 @@ RSpec.describe Spree::Api::V3::GiftCardSerializer do
context 'with partially redeemed gift card' do
let(:gift_card) { create(:gift_card, store: store, state: :partially_redeemed, amount: 100, amount_used: 40) }
- it 'returns partially_redeemed state' do
- expect(subject['state']).to eq('partially_redeemed')
+ it 'returns partially_redeemed status' do
+ expect(subject['status']).to eq('partially_redeemed')
end
it 'returns correct remaining amount' do
diff --git a/spree/api/spec/serializers/spree/api/v3/newsletter_subscriber_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/newsletter_subscriber_serializer_spec.rb
index 50662f9c99..61cb4e6b98 100644
--- a/spree/api/spec/serializers/spree/api/v3/newsletter_subscriber_serializer_spec.rb
+++ b/spree/api/spec/serializers/spree/api/v3/newsletter_subscriber_serializer_spec.rb
@@ -11,7 +11,7 @@ RSpec.describe Spree::Api::V3::NewsletterSubscriberSerializer do
it 'includes all expected attributes' do
expect(subject.keys).to match_array(%w[
- id email verified verified_at user_id created_at updated_at
+ id email verified verified_at customer_id created_at updated_at
])
end
diff --git a/spree/api/spec/serializers/spree/api/v3/payment_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/payment_serializer_spec.rb
index ed4d3f85b0..b597d75b6c 100644
--- a/spree/api/spec/serializers/spree/api/v3/payment_serializer_spec.rb
+++ b/spree/api/spec/serializers/spree/api/v3/payment_serializer_spec.rb
@@ -12,7 +12,7 @@ RSpec.describe Spree::Api::V3::PaymentSerializer do
it 'includes standard attributes' do
expect(subject).to include(
'id' => payment.prefixed_id,
- 'state' => 'checkout',
+ 'status' => 'checkout',
'number' => payment.number,
'response_code' => '12345'
)
diff --git a/spree/core/app/models/spree/inventory_unit.rb b/spree/core/app/models/spree/inventory_unit.rb
index 85f300e5f5..39da3d202d 100644
--- a/spree/core/app/models/spree/inventory_unit.rb
+++ b/spree/core/app/models/spree/inventory_unit.rb
@@ -1,6 +1,6 @@
module Spree
class InventoryUnit < Spree.base_class
- has_prefix_id :iu
+ has_prefix_id :fi
extend Spree::DisplayMoney
diff --git a/spree/core/app/models/spree/shipment.rb b/spree/core/app/models/spree/shipment.rb
index 0b34191f6a..ccb7de0618 100644
--- a/spree/core/app/models/spree/shipment.rb
+++ b/spree/core/app/models/spree/shipment.rb
@@ -2,7 +2,7 @@ require 'ostruct'
module Spree
class Shipment < Spree.base_class
- has_prefix_id :ship # Spree-specific: shipment
+ has_prefix_id :ful
include Spree::Core::NumberGenerator.new(prefix: 'H', length: 11)
include Spree::NumberIdentifier
diff --git a/spree/core/app/models/spree/shipping_method.rb b/spree/core/app/models/spree/shipping_method.rb
index 31c33dfe73..d42784b92a 100644
--- a/spree/core/app/models/spree/shipping_method.rb
+++ b/spree/core/app/models/spree/shipping_method.rb
@@ -1,6 +1,6 @@
module Spree
class ShippingMethod < Spree.base_class
- has_prefix_id :shpm # Spree-specific: shipping method
+ has_prefix_id :dm
acts_as_paranoid
include Spree::CalculatedAdjustments
diff --git a/spree/core/app/models/spree/shipping_rate.rb b/spree/core/app/models/spree/shipping_rate.rb
index c8c8785910..faee7528cd 100644
--- a/spree/core/app/models/spree/shipping_rate.rb
+++ b/spree/core/app/models/spree/shipping_rate.rb
@@ -1,6 +1,6 @@
module Spree
class ShippingRate < Spree.base_class
- has_prefix_id :shpr # Spree-specific: shipping rate
+ has_prefix_id :dr
belongs_to :shipment, class_name: 'Spree::Shipment'
belongs_to :tax_rate, -> { with_deleted }, class_name: 'Spree::TaxRate'