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.

Standardize Spree Store API entity and attribute names against indust… (#13800)

Damian Legawiec3393d18da066
diff --git a/CLAUDE.md b/CLAUDE.md
index 1e746a11a9..70fee2a5dd 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -27,6 +27,7 @@ Current plans:
- `6.0-search-provider.md` — Pluggable SearchProvider interface (Database default, Meilisearch/Elasticsearch/Algolia adapters), MetafieldDefinition faceting, autocomplete endpoint
- `6.0-tax-provider.md` — Pluggable TaxProvider interface (Internal default, Avalara/TaxJar/Vertex adapters), estimate/commit/void lifecycle, tax exemption certificates
- `5.x-store-api-bridges.md` — Bridge 6.0 naming into 5.5 Store API (fulfillments, delivery, status, remove master_variant)
+- `5.x-store-api-naming-standardization.md` — Standardize API naming against industry (address fields, discounts, customer_note, label, brand/last4, etc.)
- `spree-starter-and-create-spree-app.md` — Replace monorepo server/ with spree-starter template repo, always include backend/ in create-spree-app, add spree eject
## Monorepo Structure
diff --git a/docs/api-reference/store.yaml b/docs/api-reference/store.yaml
index 78c07e90bf..b2990f8446 100644
--- a/docs/api-reference/store.yaml
+++ b/docs/api-reference/store.yaml
@@ -99,13 +99,13 @@ paths:
example:
data:
- id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 3 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: NAME_1
@@ -115,13 +115,13 @@ paths:
quick_checkout: false
state_name: STATE_NAME_1
- id: addr_gbHJdmfrXB
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 2 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -131,13 +131,13 @@ paths:
quick_checkout: false
state_name: STATE_NAME_3
- id: addr_UkLWZg9DAJ
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 1 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -195,11 +195,11 @@ paths:
})
const address = await client.customer.addresses.create({
- firstname: 'John',
- lastname: 'Doe',
+ first_name: 'John',
+ last_name: 'Doe',
address1: '123 Main St',
city: 'New York',
- zipcode: '10001',
+ postal_code: '10001',
country_iso: 'US',
state_abbr: 'NY',
phone: '+1 555 123 4567',
@@ -224,13 +224,13 @@ paths:
application/json:
example:
id: addr_VqXmZF31wY
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 123 Main St
address2:
+ postal_code: '10001'
city: New York
- zipcode: '10001'
phone: "+1 555 123 4567"
company:
country_name: NAME_3
@@ -272,10 +272,10 @@ paths:
schema:
type: object
properties:
- firstname:
+ first_name:
type: string
example: John
- lastname:
+ last_name:
type: string
example: Doe
address1:
@@ -287,7 +287,7 @@ paths:
city:
type: string
example: New York
- zipcode:
+ postal_code:
type: string
example: '10001'
phone:
@@ -310,11 +310,11 @@ paths:
example: New York
description: State name - for countries without predefined states
required:
- - firstname
- - lastname
+ - first_name
+ - last_name
- address1
- city
- - zipcode
+ - postal_code
- country_iso
"/api/v3/store/customer/addresses/{id}":
get:
@@ -368,13 +368,13 @@ paths:
application/json:
example:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 15 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: NAME_5
@@ -441,13 +441,13 @@ paths:
application/json:
example:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 21 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Los Angeles
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: NAME_7
@@ -464,10 +464,10 @@ paths:
schema:
type: object
properties:
- firstname:
+ first_name:
type: string
example: John
- lastname:
+ last_name:
type: string
example: Doe
address1:
@@ -573,13 +573,13 @@ paths:
application/json:
example:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 30 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: NAME_10
@@ -661,17 +661,17 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6ImUxNmIzMTA4LTkzNjUtNDA5YS04MTlmLWM1YWUzNGQ0ZTk0MiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczNzU3ODYyfQ.ckgPs71jNwRgeGSYqIcotysVDCSAAUhvk_GHRJTSRnQ
- refresh_token: bLzrrimH27YjfKSWHmpv59nD
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjQ2NWE2MzFlLWFlOGItNDE5ZC1iOWZiLWJiNDI4NzIwODZiNyIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczOTM4NTIwfQ.sanw0VZonZo8pA_sODPMs6PIL7AVSkTNiqjzNcBJRqU
+ refresh_token: 1ZnWLivcEC7dLpCy1kgs8UQe
user:
id: cus_UkLWZg9DAJ
- first_name: Zenia
- last_name: Gerlach
+ first_name: Yen
+ last_name: Torp
phone:
accepts_email_marketing: false
- created_at: '2026-03-17T13:31:02.565Z'
- updated_at: '2026-03-17T13:31:02.565Z'
+ created_at: '2026-03-19T15:42:00.088Z'
+ updated_at: '2026-03-19T15:42:00.088Z'
addresses: []
default_billing_address:
default_shipping_address:
@@ -742,17 +742,17 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6Ijg5YTYwYjQxLWJhMTUtNDdkMC1iOGZmLWQ2MGVkZjkzZDhkMSIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczNzU3ODY0fQ.Cac-aCqrH-dwXNR6lDdfp1prDTCjsE8Ak6GsjqPKm4Q
- refresh_token: HFaqot6SgwFH662V43pZa9C3
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjUzZDFjZGQ4LTcwYzQtNDc2My05MGRlLWZmNjg2MWMzZWE5MSIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczOTM4NTIxfQ.AmJ_gpZXRxphEfIwkkI9ghps0oSjeA-95GV6g6zuwz4
+ refresh_token: YfngjQmiHd5uHGrPGXDokFJF
user:
id: cus_UkLWZg9DAJ
- first_name: Elva
- last_name: Jakubowski
+ first_name: Hiedi
+ last_name: Marks
phone:
accepts_email_marketing: false
- created_at: '2026-03-17T13:31:04.024Z'
- updated_at: '2026-03-17T13:31:04.024Z'
+ created_at: '2026-03-19T15:42:01.468Z'
+ updated_at: '2026-03-19T15:42:01.468Z'
addresses: []
default_billing_address:
default_shipping_address:
@@ -821,19 +821,19 @@ paths:
example:
data:
- id: cart_gbHJdmfrXB
- number: R697243469
- token: 7bfomRAZGuJxHvALn7uiU5G6DEJZwSNTAtr
- special_instructions:
+ number: R731983525
+ token: 5f8ofYAtMcna3ciq4ESyAKdwexScdAFnPMk
+ customer_note:
currency: USD
locale: en
- item_count: 1
+ total_quantity: 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"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -842,24 +842,24 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-17T13:31:04.882Z'
- updated_at: '2026-03-17T13:31:04.934Z'
delivery_total: '100.0'
display_delivery_total: "$100.00"
+ created_at: '2026-03-19T15:42:02.199Z'
+ updated_at: '2026-03-19T15:42:02.250Z'
current_step: address
completed_steps: []
requirements:
- step: payment
field: payment
message: Add a payment method
- promotions: []
+ discounts: []
items:
- id: li_gbHJdmfrXB
variant_id: variant_gbHJdmfrXB
quantity: 1
currency: USD
- name: Product 23761
- slug: product-23761
+ name: Product 25630
+ slug: product-25630
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -871,28 +871,28 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_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-17T13:31:04.912Z'
- updated_at: '2026-03-17T13:31:04.912Z'
+ created_at: '2026-03-19T15:42:02.229Z'
+ updated_at: '2026-03-19T15:42:02.229Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_gbHJdmfrXB
- number: H32519968460
+ number: H77505544065
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-17T13:31:04.921Z'
- updated_at: '2026-03-17T13:31:04.931Z'
+ created_at: '2026-03-19T15:42:02.237Z'
+ updated_at: '2026-03-19T15:42:02.248Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -907,7 +907,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_37
- name: Sheri Hodkiewicz
+ name: Lawrence Wisozk
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -926,15 +926,15 @@ paths:
name: UPS Ground
code: UPS_GROUND
payments: []
- bill_address:
+ billing_address:
id: addr_uw2YK1rnl0
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 41 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -943,15 +943,15 @@ paths:
state_abbr: STATE_ABBR_41
quick_checkout: false
state_name: STATE_NAME_41
- ship_address:
+ shipping_address:
id: addr_OIJLhNcSbf
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 42 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -962,19 +962,19 @@ paths:
state_name: STATE_NAME_42
payment_methods: []
- id: cart_UkLWZg9DAJ
- number: R021779891
- token: unW9g9qmuoF7jHUHY2Gv7KsksJpLpPck1A7
- special_instructions:
+ number: R778059430
+ token: XhZCHiEaS5Rv55BD2Y9Nw19gpEhrWi4kHVd
+ customer_note:
currency: USD
locale: en
- item_count: 1
+ total_quantity: 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"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -983,24 +983,24 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-17T13:31:04.716Z'
- updated_at: '2026-03-17T13:31:04.876Z'
delivery_total: '100.0'
display_delivery_total: "$100.00"
+ created_at: '2026-03-19T15:42:02.045Z'
+ updated_at: '2026-03-19T15:42:02.193Z'
current_step: address
completed_steps: []
requirements:
- step: payment
field: payment
message: Add a payment method
- promotions: []
+ discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 1217
- slug: product-1217
+ name: Product 14382
+ slug: product-14382
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1012,28 +1012,28 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_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-17T13:31:04.796Z'
- updated_at: '2026-03-17T13:31:04.796Z'
+ created_at: '2026-03-19T15:42:02.115Z'
+ updated_at: '2026-03-19T15:42:02.115Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H60685875733
+ number: H25610848952
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-17T13:31:04.812Z'
- updated_at: '2026-03-17T13:31:04.871Z'
+ created_at: '2026-03-19T15:42:02.144Z'
+ updated_at: '2026-03-19T15:42:02.188Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -1048,7 +1048,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_37
- name: Sheri Hodkiewicz
+ name: Lawrence Wisozk
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1067,15 +1067,15 @@ paths:
name: UPS Ground
code: UPS_GROUND
payments: []
- bill_address:
+ billing_address:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 39 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -1084,15 +1084,15 @@ paths:
state_abbr: STATE_ABBR_39
quick_checkout: false
state_name: STATE_NAME_39
- ship_address:
+ shipping_address:
id: addr_VqXmZF31wY
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 40 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -1176,19 +1176,19 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R671255877
- token: ddJ7VqTu6PyWaTgA2SDFQGYKJ1wqnDrvuSz
+ number: R842662849
+ token: 8TAPjfzVJXz8Fa3us5kxrK4qqE5qfbxi4oC
email:
- special_instructions:
+ customer_note:
currency: USD
locale: en
- item_count: 0
+ total_quantity: 0
item_total: '0.0'
display_item_total: "$0.00"
adjustment_total: '0.0'
display_adjustment_total: "$0.00"
- promo_total: '0.0'
- display_promo_total: "$0.00"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -1197,10 +1197,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '0.0'
display_total: "$0.00"
- created_at: '2026-03-17T13:31:05.668Z'
- updated_at: '2026-03-17T13:31:05.668Z'
delivery_total: '0.0'
display_delivery_total: "$0.00"
+ created_at: '2026-03-19T15:42:02.749Z'
+ updated_at: '2026-03-19T15:42:02.749Z'
current_step: address
completed_steps: []
requirements:
@@ -1216,12 +1216,12 @@ paths:
- step: delivery
field: shipping_method
message: Select a shipping method for all shipments
- promotions: []
+ discounts: []
items: []
fulfillments: []
payments: []
- bill_address:
- ship_address:
+ billing_address:
+ shipping_address:
payment_methods: []
schema:
"$ref": "#/components/schemas/Cart"
@@ -1307,19 +1307,19 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R494225149
- token: PjhEZ59PPi81AcWawUHfYX7oZYW1duqzEGg
- special_instructions:
+ number: R950324320
+ token: YbfFTuUxLzsja7tXidom6yAwWGyyUSs5yQP
+ customer_note:
currency: USD
locale: en
- item_count: 1
+ total_quantity: 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"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -1328,24 +1328,24 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-17T13:31:05.962Z'
- updated_at: '2026-03-17T13:31:06.059Z'
delivery_total: '100.0'
display_delivery_total: "$100.00"
+ created_at: '2026-03-19T15:42:03.030Z'
+ updated_at: '2026-03-19T15:42:03.089Z'
current_step: address
completed_steps: []
requirements:
- step: payment
field: payment
message: Add a payment method
- promotions: []
+ discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 52169
- slug: product-52169
+ name: Product 52307
+ slug: product-52307
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1357,28 +1357,28 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_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-17T13:31:06.023Z'
- updated_at: '2026-03-17T13:31:06.023Z'
+ created_at: '2026-03-19T15:42:03.065Z'
+ updated_at: '2026-03-19T15:42:03.065Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H00356197759
+ number: H43284193261
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-17T13:31:06.030Z'
- updated_at: '2026-03-17T13:31:06.056Z'
+ created_at: '2026-03-19T15:42:03.071Z'
+ updated_at: '2026-03-19T15:42:03.087Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -1393,7 +1393,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_47
- name: Rocio Witting
+ name: Bibi Aufderhar
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1412,15 +1412,15 @@ paths:
name: UPS Ground
code: UPS_GROUND
payments: []
- bill_address:
+ billing_address:
id: addr_UkLWZg9DAJ
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 47 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -1429,15 +1429,15 @@ paths:
state_abbr: STATE_ABBR_47
quick_checkout: false
state_name: STATE_NAME_47
- ship_address:
+ shipping_address:
id: addr_gbHJdmfrXB
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 48 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -1466,9 +1466,8 @@ paths:
security:
- api_key: []
bearer_auth: []
- description: Updates cart info (email, addresses, special instructions). When
- addresses change, the order state is reverted to address to ensure shipments
- are recalculated.
+ description: Updates cart info (email, addresses, customer note). When addresses
+ change, the order state is reverted to address to ensure shipments are recalculated.
x-codeSamples:
- lang: javascript
label: Spree SDK
@@ -1482,12 +1481,12 @@ paths:
const cart = await client.carts.update('cart_abc123', {
- ship_address: {
- firstname: 'John',
- lastname: 'Doe',
+ shipping_address: {
+ first_name: 'John',
+ last_name: 'Doe',
address1: '123 Main St',
city: 'New York',
- zipcode: '10001',
+ postal_code: '10001',
country_iso: 'US',
state_abbr: 'NY',
},
@@ -1528,19 +1527,19 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R675289587
- token: Nv9t7Fad6UERBzGLVhF4Q4h5rRXp6hB9anC
- special_instructions: Leave at door
+ number: R321229614
+ token: G4wLk8W8yGL1arYtQrfUaoGgqBpm2pgmQxT
+ customer_note: Leave at door
currency: USD
locale: en
- item_count: 1
+ total_quantity: 1
item_total: '19.99'
display_item_total: "$19.99"
adjustment_total: '0.0'
display_adjustment_total: "$0.00"
- promo_total: '0.0'
- display_promo_total: "$0.00"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -1549,10 +1548,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '29.99'
display_total: "$29.99"
- created_at: '2026-03-17T13:31:06.661Z'
- updated_at: '2026-03-17T13:31:06.817Z'
delivery_total: '10.0'
display_delivery_total: "$10.00"
+ created_at: '2026-03-19T15:42:03.683Z'
+ updated_at: '2026-03-19T15:42:03.831Z'
current_step: payment
completed_steps:
- address
@@ -1561,14 +1560,14 @@ paths:
- step: payment
field: payment
message: Add a payment method
- promotions: []
+ discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 67748
- slug: product-67748
+ name: Product 66350
+ slug: product-66350
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -1580,28 +1579,28 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
pre_tax_amount: '19.99'
display_pre_tax_amount: "$19.99"
discounted_amount: '19.99'
display_discounted_amount: "$19.99"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-17T13:31:06.691Z'
- updated_at: '2026-03-17T13:31:06.769Z'
+ created_at: '2026-03-19T15:42:03.718Z'
+ updated_at: '2026-03-19T15:42:03.784Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_gbHJdmfrXB
- number: H69146355063
+ number: H21304492064
tracking:
tracking_url:
cost: '10.0'
display_cost: "$10.00"
- created_at: '2026-03-17T13:31:06.787Z'
- updated_at: '2026-03-17T13:31:06.801Z'
+ created_at: '2026-03-19T15:42:03.801Z'
+ updated_at: '2026-03-19T15:42:03.815Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -1616,7 +1615,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_49
- name: Lucina Johnson
+ name: Ami Shields
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1635,15 +1634,15 @@ paths:
name: UPS Ground
code: UPS_GROUND
payments: []
- bill_address:
+ billing_address:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 51 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -1652,15 +1651,15 @@ paths:
state_abbr: STATE_ABBR_51
quick_checkout: false
state_name: STATE_NAME_51
- ship_address:
+ shipping_address:
id: addr_VqXmZF31wY
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 52 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -1682,26 +1681,26 @@ paths:
type: string
format: email
- special_instructions:
+ customer_note:
type: string
example: Leave at door
metadata:
type: object
additionalProperties: true
- ship_address_id:
+ shipping_address_id:
type: string
description: Existing address ID to use as shipping address
example: addr_abc123
- bill_address_id:
+ billing_address_id:
type: string
description: Existing address ID to use as billing address
example: addr_def456
- bill_address:
+ billing_address:
type: object
properties:
- firstname:
+ first_name:
type: string
- lastname:
+ last_name:
type: string
address1:
type: string
@@ -1709,7 +1708,7 @@ paths:
type: string
city:
type: string
- zipcode:
+ postal_code:
type: string
phone:
type: string
@@ -1719,12 +1718,12 @@ paths:
type: string
state_abbr:
type: string
- ship_address:
+ shipping_address:
type: object
properties:
- firstname:
+ first_name:
type: string
- lastname:
+ last_name:
type: string
address1:
type: string
@@ -1732,7 +1731,7 @@ paths:
type: string
city:
type: string
- zipcode:
+ postal_code:
type: string
phone:
type: string
@@ -1838,19 +1837,19 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R534753884
- token: LkNFFRxRAPfzLkoqALbqo8NDvKfmQ9oiFjS
- special_instructions:
+ number: R193323089
+ token: p8RyTbCuUZTP8n2gu8DrfJzNeEMEVzLWzcD
+ customer_note:
currency: USD
locale: en
- item_count: 1
+ total_quantity: 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"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -1859,24 +1858,24 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-17T13:31:07.637Z'
- updated_at: '2026-03-17T13:31:07.698Z'
delivery_total: '100.0'
display_delivery_total: "$100.00"
+ created_at: '2026-03-19T15:42:04.507Z'
+ updated_at: '2026-03-19T15:42:04.580Z'
current_step: address
completed_steps: []
requirements:
- step: payment
field: payment
message: Add a payment method
- promotions: []
+ discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 86043
- slug: product-86043
+ name: Product 86626
+ slug: product-86626
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1888,28 +1887,28 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_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-17T13:31:07.674Z'
- updated_at: '2026-03-17T13:31:07.674Z'
+ created_at: '2026-03-19T15:42:04.536Z'
+ updated_at: '2026-03-19T15:42:04.536Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H73657546437
+ number: H72961408706
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-17T13:31:07.681Z'
- updated_at: '2026-03-17T13:31:07.695Z'
+ created_at: '2026-03-19T15:42:04.546Z'
+ updated_at: '2026-03-19T15:42:04.575Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -1924,7 +1923,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_57
- name: Winnie Nolan
+ name: Delmer Kemmer
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1943,15 +1942,15 @@ paths:
name: UPS Ground
code: UPS_GROUND
payments: []
- bill_address:
+ billing_address:
id: addr_UkLWZg9DAJ
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 57 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -1960,15 +1959,15 @@ paths:
state_abbr: STATE_ABBR_57
quick_checkout: false
state_name: STATE_NAME_57
- ship_address:
+ shipping_address:
id: addr_gbHJdmfrXB
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 58 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -2043,18 +2042,18 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R516410685
- special_instructions:
+ number: R559004981
+ customer_note:
currency: USD
locale: en
- item_count: 1
+ total_quantity: 1
item_total: '19.99'
display_item_total: "$19.99"
adjustment_total: '0.0'
display_adjustment_total: "$0.00"
- promo_total: '0.0'
- display_promo_total: "$0.00"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -2063,21 +2062,21 @@ paths:
display_additional_tax_total: "$0.00"
total: '29.99'
display_total: "$29.99"
- completed_at: '2026-03-17T13:31:09.316Z'
- created_at: '2026-03-17T13:31:09.079Z'
- updated_at: '2026-03-17T13:31:09.316Z'
- fulfillment_status: backorder
- payment_status: paid
delivery_total: '10.0'
display_delivery_total: "$10.00"
- promotions: []
+ fulfillment_status: backorder
+ payment_status: paid
+ completed_at: '2026-03-19T15:42:05.995Z'
+ created_at: '2026-03-19T15:42:05.798Z'
+ updated_at: '2026-03-19T15:42:05.995Z'
+ discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 101409
- slug: product-101409
+ name: Product 103222
+ slug: product-103222
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -2089,28 +2088,28 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
pre_tax_amount: '19.99'
display_pre_tax_amount: "$19.99"
discounted_amount: '19.99'
display_discounted_amount: "$19.99"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-17T13:31:09.115Z'
- updated_at: '2026-03-17T13:31:09.320Z'
+ created_at: '2026-03-19T15:42:05.825Z'
+ updated_at: '2026-03-19T15:42:05.998Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_gbHJdmfrXB
- number: H27475079463
+ number: H65253286788
tracking:
tracking_url:
cost: '10.0'
display_cost: "$10.00"
- created_at: '2026-03-17T13:31:09.191Z'
- updated_at: '2026-03-17T13:31:09.309Z'
+ created_at: '2026-03-19T15:42:05.883Z'
+ updated_at: '2026-03-19T15:42:05.989Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -2125,7 +2124,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_63
- name: Shonna Grant
+ name: Mariann Ondricka
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -2147,38 +2146,37 @@ paths:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
response_code: '12345'
- number: PEHEUNS0
+ number: PMLH2GMG
amount: '29.99'
display_amount: "$29.99"
- created_at: '2026-03-17T13:31:09.266Z'
- updated_at: '2026-03-17T13:31:09.290Z'
+ created_at: '2026-03-19T15:42:05.946Z'
+ updated_at: '2026-03-19T15:42:05.971Z'
status: completed
source_type: credit_card
source_id: card_UkLWZg9DAJ
source:
id: card_UkLWZg9DAJ
- cc_type: visa
- last_digits: '1111'
+ brand: visa
+ last4: '1111'
month: 12
year: 2027
name: Spree Commerce
default: false
- gateway_payment_profile_id:
payment_method:
id: pm_UkLWZg9DAJ
name: Check
description:
type: Spree::PaymentMethod::Check
session_required: false
- bill_address:
+ billing_address:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 65 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -2187,15 +2185,15 @@ paths:
state_abbr: STATE_ABBR_65
quick_checkout: false
state_name: STATE_NAME_65
- ship_address:
+ shipping_address:
id: addr_VqXmZF31wY
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 66 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -2284,8 +2282,8 @@ paths:
meta_description:
meta_keywords:
children_count: 1
- created_at: '2026-03-17T13:31:09.991Z'
- updated_at: '2026-03-17T13:31:10.098Z'
+ created_at: '2026-03-19T15:42:06.635Z'
+ updated_at: '2026-03-19T15:42:06.704Z'
parent_id:
description: ''
description_html: ''
@@ -2303,8 +2301,8 @@ paths:
meta_description:
meta_keywords:
children_count: 1
- created_at: '2026-03-17T13:31:10.001Z'
- updated_at: '2026-03-17T13:31:10.098Z'
+ created_at: '2026-03-19T15:42:06.643Z'
+ updated_at: '2026-03-19T15:42:06.703Z'
parent_id: ctg_UkLWZg9DAJ
description: ''
description_html: ''
@@ -2322,8 +2320,8 @@ paths:
meta_description:
meta_keywords:
children_count: 0
- created_at: '2026-03-17T13:31:10.013Z'
- updated_at: '2026-03-17T13:31:10.030Z'
+ created_at: '2026-03-19T15:42:06.655Z'
+ updated_at: '2026-03-19T15:42:06.660Z'
parent_id: ctg_gbHJdmfrXB
description: ''
description_html: ''
@@ -2424,8 +2422,8 @@ paths:
meta_description:
meta_keywords:
children_count: 1
- created_at: '2026-03-17T13:31:10.505Z'
- updated_at: '2026-03-17T13:31:10.543Z'
+ created_at: '2026-03-19T15:42:07.027Z'
+ updated_at: '2026-03-19T15:42:07.067Z'
parent_id: ctg_UkLWZg9DAJ
description: ''
description_html: ''
@@ -2552,18 +2550,17 @@ paths:
example:
data:
- id: prod_UkLWZg9DAJ
- name: Product 199073
- description: |-
- Cumque enim consequatur eos nobis. Consequatur minus asperiores laudantium eius dolores suscipit ut accusamus. Vel magni iusto molestiae necessitatibus sed nisi odit. Sed soluta omnis enim voluptatum velit in ex odit. Nostrum quis labore hic quo numquam soluta.
- Architecto numquam quidem fugiat ut sapiente. Perferendis cupiditate ducimus nemo ex libero illo. Cupiditate dolor assumenda laboriosam earum repellat ad.
- Impedit corporis quae nemo officia sit voluptatibus beatae. Suscipit molestias ipsam laboriosam id aperiam asperiores. Totam fugiat hic tenetur nam optio sint.
- slug: product-199073
+ name: Product 199378
+ description: Architecto occaecati error nesciunt quisquam consectetur
+ consequatur. Eaque omnis iure similique nesciunt. Tenetur nam
+ ratione voluptas veniam debitis.
+ slug: product-199378
meta_description:
meta_keywords:
variant_count: 0
- available_on: '2025-03-17T13:31:11.026Z'
- created_at: '2026-03-17T13:31:11.039Z'
- updated_at: '2026-03-17T13:31:11.052Z'
+ available_on: '2025-03-19T15:42:07.551Z'
+ created_at: '2026-03-19T15:42:07.568Z'
+ updated_at: '2026-03-19T15:42:07.582Z'
purchasable: true
in_stock: false
backorderable: true
@@ -2833,19 +2830,19 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R548970950
- token: 1ohw9b5fkMFfn955mYHyMeFrQZJya4pM7SD
- special_instructions:
+ number: R188296245
+ token: fcqCpYfpmyf1JposJ2Bi7uPJKZuoGUdC3E8
+ customer_note:
currency: USD
locale: en
- item_count: 1
+ total_quantity: 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"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -2854,21 +2851,21 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-17T13:31:13.005Z'
- updated_at: '2026-03-17T13:31:13.154Z'
delivery_total: '100.0'
display_delivery_total: "$100.00"
+ created_at: '2026-03-19T15:42:09.440Z'
+ updated_at: '2026-03-19T15:42:09.550Z'
current_step: address
completed_steps: []
requirements: []
- promotions: []
+ discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 235106
- slug: product-235106
+ name: Product 239287
+ slug: product-239287
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -2880,28 +2877,28 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_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-17T13:31:13.059Z'
- updated_at: '2026-03-17T13:31:13.059Z'
+ created_at: '2026-03-19T15:42:09.474Z'
+ updated_at: '2026-03-19T15:42:09.474Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H96742613911
+ number: H29119131869
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-17T13:31:13.068Z'
- updated_at: '2026-03-17T13:31:13.089Z'
+ created_at: '2026-03-19T15:42:09.479Z'
+ updated_at: '2026-03-19T15:42:09.491Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -2916,7 +2913,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_85
- name: Luke Ebert
+ name: Hazel Christiansen
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -2937,12 +2934,12 @@ paths:
payments:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- response_code: 1-SC-20260317133113146337
- number: PMEU0DUH
+ response_code: 1-SC-20260319154209542978
+ number: PCSAIO7U
amount: '50.0'
display_amount: "$50.00"
- created_at: '2026-03-17T13:31:13.148Z'
- updated_at: '2026-03-17T13:31:13.148Z'
+ created_at: '2026-03-19T15:42:09.544Z'
+ updated_at: '2026-03-19T15:42:09.544Z'
status: checkout
source_type: store_credit
source_id: credit_UkLWZg9DAJ
@@ -2961,15 +2958,15 @@ paths:
description:
type: Spree::PaymentMethod::StoreCredit
session_required: false
- bill_address:
+ billing_address:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 77 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -2978,15 +2975,15 @@ paths:
state_abbr: STATE_ABBR_87
quick_checkout: false
state_name: STATE_NAME_87
- ship_address:
+ shipping_address:
id: addr_VqXmZF31wY
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 78 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -3086,19 +3083,19 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R758123948
- token: CWpShy9fWn96dCNAb5LNCz9knAw98gEADC8
- special_instructions:
+ number: R670087505
+ token: duHKiLCWexcSfN4NojznoVFnEMnjfnpCx62
+ customer_note:
currency: USD
locale: en
- item_count: 1
+ total_quantity: 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"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -3107,24 +3104,24 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-17T13:31:14.347Z'
- updated_at: '2026-03-17T13:31:14.464Z'
delivery_total: '100.0'
display_delivery_total: "$100.00"
+ created_at: '2026-03-19T15:42:10.740Z'
+ updated_at: '2026-03-19T15:42:10.846Z'
current_step: address
completed_steps: []
requirements:
- step: payment
field: payment
message: Add a payment method
- promotions: []
+ discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 256598
- slug: product-256598
+ name: Product 251806
+ slug: product-251806
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -3136,28 +3133,28 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_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-17T13:31:14.380Z'
- updated_at: '2026-03-17T13:31:14.460Z'
+ created_at: '2026-03-19T15:42:10.769Z'
+ updated_at: '2026-03-19T15:42:10.841Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H66029573545
+ number: H60821471370
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-17T13:31:14.388Z'
- updated_at: '2026-03-17T13:31:14.403Z'
+ created_at: '2026-03-19T15:42:10.774Z'
+ updated_at: '2026-03-19T15:42:10.788Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -3172,7 +3169,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_93
- name: Devon Bahringer
+ name: Jenae Brakus
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -3191,15 +3188,15 @@ paths:
name: UPS Ground
code: UPS_GROUND
payments: []
- bill_address:
+ billing_address:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 85 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -3208,15 +3205,15 @@ paths:
state_abbr: STATE_ABBR_95
quick_checkout: false
state_name: STATE_NAME_95
- ship_address:
+ shipping_address:
id: addr_VqXmZF31wY
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 86 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -3297,13 +3294,12 @@ paths:
example:
data:
- id: card_UkLWZg9DAJ
- cc_type: visa
- last_digits: '1111'
+ brand: visa
+ last4: '1111'
month: 12
year: 2027
name: Spree Commerce
default: false
- gateway_payment_profile_id:
meta:
page: 1
limit: 25
@@ -3386,13 +3382,12 @@ paths:
application/json:
example:
id: card_UkLWZg9DAJ
- cc_type: visa
- last_digits: '1111'
+ brand: visa
+ last4: '1111'
month: 12
year: 2027
name: Spree Commerce
default: false
- gateway_payment_profile_id:
schema:
"$ref": "#/components/schemas/CreditCard"
'404':
@@ -3638,17 +3633,17 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6ImE3MGU3YWJlLTA2OTgtNDI0OS1iYWM2LThmMDljNzcwMjg0YyIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczNzU3ODc5fQ.ANjn2ggzInGM5l9T02IqBkWT-ah-wC-mF1_Y7dBTus4
- refresh_token: 6zf6EN4jw3JhDDQLvJHYrqq2
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjA5Mzg3NjFmLWU4MjgtNDFkMy1iM2JkLWQ4YmIzOGZkYzYzMiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczOTM4NTM1fQ.3oboSZapJloo2vTpyR1P1UyZqdwTYyrTsejeJoC6DhY
+ refresh_token: 3sb4obaPSqU6Po9CYVtomxP9
user:
id: cus_UkLWZg9DAJ
- first_name: Joaquina
- last_name: Lockman
+ first_name: Antonette
+ last_name: Price
phone:
accepts_email_marketing: false
- created_at: '2026-03-17T13:31:19.494Z'
- updated_at: '2026-03-17T13:31:19.767Z'
+ created_at: '2026-03-19T15:42:15.683Z'
+ updated_at: '2026-03-19T15:42:15.959Z'
addresses: []
default_billing_address:
default_shipping_address:
@@ -3736,18 +3731,18 @@ paths:
example:
data:
- id: or_UkLWZg9DAJ
- number: R274518608
- special_instructions:
+ number: R759854822
+ customer_note:
currency: USD
locale: en
- item_count: 1
+ total_quantity: 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"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -3756,21 +3751,21 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- completed_at: '2026-03-17T13:31:20.680Z'
- created_at: '2026-03-17T13:31:20.624Z'
- updated_at: '2026-03-17T13:31:20.680Z'
- fulfillment_status:
- payment_status:
delivery_total: '100.0'
display_delivery_total: "$100.00"
- promotions: []
+ fulfillment_status:
+ payment_status:
+ completed_at: '2026-03-19T15:42:16.871Z'
+ created_at: '2026-03-19T15:42:16.820Z'
+ updated_at: '2026-03-19T15:42:16.870Z'
+ discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 275268
- slug: product-275268
+ name: Product 272563
+ slug: product-272563
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -3782,28 +3777,28 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_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-17T13:31:20.658Z'
- updated_at: '2026-03-17T13:31:20.658Z'
+ created_at: '2026-03-19T15:42:16.850Z'
+ updated_at: '2026-03-19T15:42:16.850Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H78837386136
+ number: H01932494821
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-17T13:31:20.663Z'
- updated_at: '2026-03-17T13:31:20.677Z'
+ created_at: '2026-03-19T15:42:16.855Z'
+ updated_at: '2026-03-19T15:42:16.868Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -3818,7 +3813,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_113
- name: Dolly Mann
+ name: Chris Deckow
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -3837,15 +3832,15 @@ paths:
name: UPS Ground
code: UPS_GROUND
payments: []
- bill_address:
+ billing_address:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 105 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -3854,15 +3849,15 @@ paths:
state_abbr: STATE_ABBR_115
quick_checkout: false
state_name: STATE_NAME_115
- ship_address:
+ shipping_address:
id: addr_VqXmZF31wY
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 106 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -3938,18 +3933,18 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R334602628
- special_instructions:
+ number: R951586902
+ customer_note:
currency: USD
locale: en
- item_count: 1
+ total_quantity: 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"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -3958,21 +3953,21 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- completed_at: '2026-03-17T13:31:21.362Z'
- created_at: '2026-03-17T13:31:21.311Z'
- updated_at: '2026-03-17T13:31:21.362Z'
- fulfillment_status:
- payment_status:
delivery_total: '100.0'
display_delivery_total: "$100.00"
- promotions: []
+ fulfillment_status:
+ payment_status:
+ completed_at: '2026-03-19T15:42:17.560Z'
+ created_at: '2026-03-19T15:42:17.502Z'
+ updated_at: '2026-03-19T15:42:17.560Z'
+ discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 293548
- slug: product-293548
+ name: Product 299015
+ slug: product-299015
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -3984,28 +3979,28 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_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-17T13:31:21.341Z'
- updated_at: '2026-03-17T13:31:21.341Z'
+ created_at: '2026-03-19T15:42:17.536Z'
+ updated_at: '2026-03-19T15:42:17.536Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H91647952388
+ number: H19436599207
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-17T13:31:21.347Z'
- updated_at: '2026-03-17T13:31:21.360Z'
+ created_at: '2026-03-19T15:42:17.541Z'
+ updated_at: '2026-03-19T15:42:17.557Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -4020,7 +4015,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_119
- name: Sherri Parker
+ name: Neal Lockman
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -4039,15 +4034,15 @@ paths:
name: UPS Ground
code: UPS_GROUND
payments: []
- bill_address:
+ billing_address:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 111 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -4056,15 +4051,15 @@ paths:
state_abbr: STATE_ABBR_121
quick_checkout: false
state_name: STATE_NAME_121
- ship_address:
+ shipping_address:
id: addr_VqXmZF31wY
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 112 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -4126,8 +4121,8 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6ImM2NjRlMmFmLTViZjUtNGYyMC04YmFhLTcyMDY5ZmI3YmNhZiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczNzU3ODgyfQ.RxdDcn7lKEQdzdF8Db5vir-EmSbizc9G0Iy2K8wDiEo
- refresh_token: 1eSBudYGmhKZrRr3RsbfwnhR
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjhiNjZjZTU1LTBiZDctNDljNS04NjgxLTEzMjllZTQ4Njk5YyIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzczOTM4NTM4fQ.5vZonSZ6Im88jAfYpXnlXkKLu6uwe8G2sSxMl58rKpM
+ refresh_token: BbfceGQZxywS9AuWhK2uEKks
user:
id: cus_UkLWZg9DAJ
@@ -4135,8 +4130,8 @@ paths:
last_name: Doe
phone: "+1234567890"
accepts_email_marketing: true
- created_at: '2026-03-17T13:31:22.815Z'
- updated_at: '2026-03-17T13:31:22.815Z'
+ created_at: '2026-03-19T15:42:18.773Z'
+ updated_at: '2026-03-19T15:42:18.773Z'
addresses: []
default_billing_address:
default_shipping_address:
@@ -4240,22 +4235,22 @@ paths:
application/json:
example:
id: cus_UkLWZg9DAJ
- first_name: Ada
- last_name: Russel
+ first_name: Jacquline
+ last_name: Runolfsson
phone: 555-555-0199
accepts_email_marketing: false
- created_at: '2026-03-17T13:31:23.410Z'
- updated_at: '2026-03-17T13:31:23.682Z'
+ created_at: '2026-03-19T15:42:19.322Z'
+ updated_at: '2026-03-19T15:42:19.593Z'
addresses:
- id: addr_gbHJdmfrXB
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 118 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -4265,13 +4260,13 @@ paths:
quick_checkout: false
state_name: STATE_NAME_128
- id: addr_UkLWZg9DAJ
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 117 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -4282,13 +4277,13 @@ paths:
state_name: STATE_NAME_127
default_billing_address:
id: addr_gbHJdmfrXB
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 118 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -4299,13 +4294,13 @@ paths:
state_name: STATE_NAME_128
default_shipping_address:
id: addr_UkLWZg9DAJ
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 117 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -4370,22 +4365,22 @@ 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-17T13:31:23.978Z'
- updated_at: '2026-03-17T13:31:24.465Z'
+ created_at: '2026-03-19T15:42:19.882Z'
+ updated_at: '2026-03-19T15:42:20.161Z'
addresses:
- id: addr_gbHJdmfrXB
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 120 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -4395,13 +4390,13 @@ paths:
quick_checkout: false
state_name: STATE_NAME_130
- id: addr_UkLWZg9DAJ
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 119 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -4412,13 +4407,13 @@ paths:
state_name: STATE_NAME_129
default_billing_address:
id: addr_gbHJdmfrXB
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 120 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -4429,13 +4424,13 @@ paths:
state_name: STATE_NAME_130
default_shipping_address:
id: addr_UkLWZg9DAJ
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 119 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -4595,13 +4590,13 @@ paths:
example:
data:
- id: ful_UkLWZg9DAJ
- number: H09695067944
+ number: H17706263452
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-17T13:31:27.925Z'
- updated_at: '2026-03-17T13:31:27.939Z'
+ created_at: '2026-03-19T15:42:23.295Z'
+ updated_at: '2026-03-19T15:42:23.309Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -4616,7 +4611,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_145
- name: Pamelia Beer
+ name: Jamal Romaguera
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -4698,19 +4693,19 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R312977713
- token: K8bzQ36zyaDf8epBWgEMTdFfnQPrjgoMEgV
- special_instructions:
+ number: R044723075
+ token: YMj88TDU47b6sp9PXgjFRyKwjnQk3LbVNnq
+ customer_note:
currency: USD
locale: en
- item_count: 1
+ total_quantity: 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"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -4719,10 +4714,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-17T13:31:28.508Z'
- updated_at: '2026-03-17T13:31:28.600Z'
delivery_total: '100.0'
display_delivery_total: "$100.00"
+ created_at: '2026-03-19T15:42:23.869Z'
+ updated_at: '2026-03-19T15:42:23.952Z'
current_step: payment
completed_steps:
- address
@@ -4731,14 +4726,14 @@ paths:
- step: payment
field: payment
message: Add a payment method
- promotions: []
+ discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 388607
- slug: product-388607
+ name: Product 386770
+ slug: product-386770
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -4750,28 +4745,28 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_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-17T13:31:28.541Z'
- updated_at: '2026-03-17T13:31:28.541Z'
+ created_at: '2026-03-19T15:42:23.898Z'
+ updated_at: '2026-03-19T15:42:23.898Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H51846293008
+ number: H26214284572
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-17T13:31:28.547Z'
- updated_at: '2026-03-17T13:31:28.583Z'
+ created_at: '2026-03-19T15:42:23.902Z'
+ updated_at: '2026-03-19T15:42:23.935Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -4786,7 +4781,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_149
- name: Rory Schaefer
+ name: Alyssa Reichel
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -4805,15 +4800,15 @@ paths:
name: UPS Ground
code: UPS_GROUND
payments: []
- bill_address:
+ billing_address:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 141 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -4822,15 +4817,15 @@ paths:
state_abbr: STATE_ABBR_151
quick_checkout: false
state_name: STATE_NAME_151
- ship_address:
+ shipping_address:
id: addr_VqXmZF31wY
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 142 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -4923,7 +4918,7 @@ paths:
example:
data:
- id: gc_UkLWZg9DAJ
- code: D5C45BB9DD347FF0
+ code: 46BE8947862EE3C7
status: active
currency: USD
amount: '10.0'
@@ -4937,8 +4932,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-03-17T13:31:29.947Z'
- updated_at: '2026-03-17T13:31:29.947Z'
+ created_at: '2026-03-19T15:42:25.131Z'
+ updated_at: '2026-03-19T15:42:25.131Z'
meta:
page: 1
limit: 25
@@ -5021,7 +5016,7 @@ paths:
application/json:
example:
id: gc_UkLWZg9DAJ
- code: 470987BEE687983D
+ code: 8D8FF0871DDEFE81
status: active
currency: USD
amount: '10.0'
@@ -5035,8 +5030,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-03-17T13:31:31.050Z'
- updated_at: '2026-03-17T13:31:31.050Z'
+ created_at: '2026-03-19T15:42:26.227Z'
+ updated_at: '2026-03-19T15:42:26.227Z'
schema:
"$ref": "#/components/schemas/GiftCard"
'404':
@@ -5113,19 +5108,19 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R827338349
- token: J58SZzPH5sditEnV3Q5NeMFoFPzYWNaKLiB
- special_instructions:
+ number: R046458855
+ token: fcoGd9WNBFoKYpHc5B3LnXyDsvNu8zg9AsN
+ customer_note:
currency: USD
locale: en
- item_count: 2
+ total_quantity: 2
item_total: '29.99'
display_item_total: "$29.99"
adjustment_total: '0.0'
display_adjustment_total: "$0.00"
- promo_total: '0.0'
- display_promo_total: "$0.00"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -5134,10 +5129,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '29.99'
display_total: "$29.99"
- created_at: '2026-03-17T13:31:32.877Z'
- updated_at: '2026-03-17T13:31:33.025Z'
delivery_total: '0.0'
display_delivery_total: "$0.00"
+ created_at: '2026-03-19T15:42:28.047Z'
+ updated_at: '2026-03-19T15:42:28.189Z'
current_step: address
completed_steps: []
requirements:
@@ -5150,14 +5145,14 @@ paths:
- step: payment
field: payment
message: Add a payment method
- promotions: []
+ discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 421961
- slug: product-421961
+ name: Product 427979
+ slug: product-427979
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -5169,15 +5164,15 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_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-17T13:31:32.932Z'
- updated_at: '2026-03-17T13:31:32.932Z'
+ created_at: '2026-03-19T15:42:28.105Z'
+ updated_at: '2026-03-19T15:42:28.105Z'
compare_at_amount:
thumbnail_url:
option_values: []
@@ -5186,8 +5181,8 @@ paths:
variant_id: variant_gbHJdmfrXB
quantity: 1
currency: USD
- name: Product 431769
- slug: product-431769
+ name: Product 436001
+ slug: product-436001
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -5199,30 +5194,30 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
pre_tax_amount: '19.99'
display_pre_tax_amount: "$19.99"
discounted_amount: '19.99'
display_discounted_amount: "$19.99"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-17T13:31:32.994Z'
- updated_at: '2026-03-17T13:31:32.994Z'
+ created_at: '2026-03-19T15:42:28.162Z'
+ updated_at: '2026-03-19T15:42:28.162Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments: []
payments: []
- bill_address:
+ billing_address:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 160 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -5231,7 +5226,7 @@ paths:
state_abbr: STATE_ABBR_170
quick_checkout: false
state_name: STATE_NAME_170
- ship_address:
+ shipping_address:
payment_methods: []
schema:
"$ref": "#/components/schemas/Cart"
@@ -5327,19 +5322,19 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R480934325
- token: 6ovgFsi8GH2ZGNNzeEiKNLn3huW6izmpycy
- special_instructions:
+ number: R274855688
+ token: VE9tebcJT9PpwS6zimLZnjWbojCsjT6MR2n
+ customer_note:
currency: USD
locale: en
- item_count: 0
+ total_quantity: 0
item_total: '0.0'
display_item_total: "$0.00"
adjustment_total: '0.0'
display_adjustment_total: "$0.00"
- promo_total: '0.0'
- display_promo_total: "$0.00"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -5348,10 +5343,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '0.0'
display_total: "$0.00"
- created_at: '2026-03-17T13:31:35.060Z'
- updated_at: '2026-03-17T13:31:35.095Z'
delivery_total: '0.0'
display_delivery_total: "$0.00"
+ created_at: '2026-03-19T15:42:29.943Z'
+ updated_at: '2026-03-19T15:42:29.974Z'
current_step: address
completed_steps: []
requirements:
@@ -5361,14 +5356,14 @@ paths:
- step: delivery
field: shipping_method
message: Select a shipping method for all shipments
- promotions: []
+ discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 462397
- slug: product-462397
+ name: Product 469844
+ slug: product-469844
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -5380,30 +5375,30 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_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-17T13:31:35.095Z'
- updated_at: '2026-03-17T13:31:35.114Z'
+ created_at: '2026-03-19T15:42:29.974Z'
+ updated_at: '2026-03-19T15:42:29.992Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments: []
payments: []
- bill_address:
+ billing_address:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 169 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -5412,7 +5407,7 @@ paths:
state_abbr: STATE_ABBR_179
quick_checkout: false
state_name: STATE_NAME_179
- ship_address:
+ shipping_address:
payment_methods: []
schema:
"$ref": "#/components/schemas/Cart"
@@ -5488,19 +5483,19 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R637650730
- token: BQtHn7w8gcpcK4HpPKuzHEtJgMbz5PKXPtR
- special_instructions:
+ number: R159345379
+ token: VA3LzoTQsmoMHg5APxNAwE6srDGwUFuWAqz
+ customer_note:
currency: USD
locale: en
- item_count: 0
+ total_quantity: 0
item_total: '0.0'
display_item_total: "$0.00"
adjustment_total: '0.0'
display_adjustment_total: "$0.00"
- promo_total: '0.0'
- display_promo_total: "$0.00"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -5509,10 +5504,10 @@ paths:
display_additional_tax_total: "$0.00"
total: '0.0'
display_total: "$0.00"
- created_at: '2026-03-17T13:31:35.679Z'
- updated_at: '2026-03-17T13:31:35.750Z'
delivery_total: '0.0'
display_delivery_total: "$0.00"
+ created_at: '2026-03-19T15:42:30.536Z'
+ updated_at: '2026-03-19T15:42:30.591Z'
current_step: address
completed_steps: []
requirements:
@@ -5525,19 +5520,19 @@ paths:
- step: delivery
field: shipping_method
message: Select a shipping method for all shipments
- promotions: []
+ discounts: []
items: []
fulfillments: []
payments: []
- bill_address:
+ billing_address:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 172 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -5546,7 +5541,7 @@ paths:
state_abbr: STATE_ABBR_182
quick_checkout: false
state_name: STATE_NAME_182
- ship_address:
+ shipping_address:
payment_methods: []
schema:
"$ref": "#/components/schemas/Cart"
@@ -6064,18 +6059,18 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R094228688
+ number: R784339045
- special_instructions:
+ customer_note:
currency: USD
locale: en
- item_count: 1
+ total_quantity: 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"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -6084,21 +6079,21 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- completed_at: '2026-03-17T13:31:37.735Z'
- created_at: '2026-03-17T13:31:37.679Z'
- updated_at: '2026-03-17T13:31:37.734Z'
- fulfillment_status:
- payment_status:
delivery_total: '100.0'
display_delivery_total: "$100.00"
- promotions: []
+ fulfillment_status:
+ payment_status:
+ completed_at: '2026-03-19T15:42:32.335Z'
+ created_at: '2026-03-19T15:42:32.287Z'
+ updated_at: '2026-03-19T15:42:32.335Z'
+ discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 503088
- slug: product-503088
+ name: Product 503094
+ slug: product-503094
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -6110,28 +6105,28 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_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-17T13:31:37.712Z'
- updated_at: '2026-03-17T13:31:37.712Z'
+ created_at: '2026-03-19T15:42:32.315Z'
+ updated_at: '2026-03-19T15:42:32.315Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H32393637608
+ number: H12704901879
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-17T13:31:37.718Z'
- updated_at: '2026-03-17T13:31:37.732Z'
+ created_at: '2026-03-19T15:42:32.320Z'
+ updated_at: '2026-03-19T15:42:32.333Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -6146,7 +6141,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_190
- name: Coreen Cremin
+ name: Domenic Fisher
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -6165,15 +6160,15 @@ paths:
name: UPS Ground
code: UPS_GROUND
payments: []
- bill_address:
+ billing_address:
id: addr_UkLWZg9DAJ
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 180 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -6182,15 +6177,15 @@ paths:
state_abbr: STATE_ABBR_190
quick_checkout: false
state_name: STATE_NAME_190
- ship_address:
+ shipping_address:
id: addr_gbHJdmfrXB
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 181 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -6351,13 +6346,13 @@ paths:
id: ps_gbHJdmfrXB
status: pending
currency: USD
- external_id: bogus_50f4461454014df3c3f580fe
+ external_id: bogus_592c65d836c83c2daeb5c0ee
external_data:
- client_secret: bogus_secret_82b4b55ca09a4b9d
+ client_secret: bogus_secret_1f165319d37cb6cb
customer_external_id:
expires_at:
- created_at: '2026-03-17T13:31:40.212Z'
- updated_at: '2026-03-17T13:31:40.212Z'
+ created_at: '2026-03-19T15:42:34.761Z'
+ updated_at: '2026-03-19T15:42:34.761Z'
amount: '110.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -6452,13 +6447,13 @@ paths:
id: ps_UkLWZg9DAJ
status: pending
currency: USD
- external_id: bogus_2c81450b3dbf127c8baba6eb
+ external_id: bogus_74edced438b885279abdf946
external_data:
client_secret: secret_123
customer_external_id:
expires_at:
- created_at: '2026-03-17T13:31:40.824Z'
- updated_at: '2026-03-17T13:31:40.824Z'
+ created_at: '2026-03-19T15:42:35.351Z'
+ updated_at: '2026-03-19T15:42:35.351Z'
amount: '110.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -6515,13 +6510,13 @@ paths:
id: ps_UkLWZg9DAJ
status: pending
currency: USD
- external_id: bogus_170c0d463f37fb14d294d956
+ external_id: bogus_c62f818d231eee224cb2ce57
external_data:
client_secret: secret_123
customer_external_id:
expires_at:
- created_at: '2026-03-17T13:31:42.189Z'
- updated_at: '2026-03-17T13:31:42.205Z'
+ created_at: '2026-03-19T15:42:36.578Z'
+ updated_at: '2026-03-19T15:42:36.591Z'
amount: '50.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -6618,13 +6613,13 @@ paths:
id: ps_UkLWZg9DAJ
status: completed
currency: USD
- external_id: bogus_d2c49cb7be375df8dc495ee1
+ external_id: bogus_fae4d71f8a0c23f0c4379582
external_data:
client_secret: secret_123
customer_external_id:
expires_at:
- created_at: '2026-03-17T13:31:42.807Z'
- updated_at: '2026-03-17T13:31:42.821Z'
+ created_at: '2026-03-19T15:42:37.196Z'
+ updated_at: '2026-03-19T15:42:37.208Z'
amount: '110.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -6704,11 +6699,11 @@ paths:
example:
id: pss_gbHJdmfrXB
status: pending
- external_id: bogus_seti_c57a7308d036f78cac969568
- external_client_secret: bogus_seti_secret_a7e281cd22b18e89
+ external_id: bogus_seti_2fdece878983cdcb48ecadb7
+ external_client_secret: bogus_seti_secret_d912dc5fd5423d63
external_data: {}
- created_at: '2026-03-17T13:31:44.054Z'
- updated_at: '2026-03-17T13:31:44.054Z'
+ created_at: '2026-03-19T15:42:38.457Z'
+ updated_at: '2026-03-19T15:42:38.457Z'
payment_method_id: pm_UkLWZg9DAJ
payment_source_id:
payment_source_type:
@@ -6805,12 +6800,12 @@ paths:
example:
id: pss_UkLWZg9DAJ
status: pending
- external_id: seti_test_0de4156b7058602d6da56ff6
- external_client_secret: seti_secret_79962547abd2392e8356076e
+ external_id: seti_test_4183504a169f22db4f263fd8
+ external_client_secret: seti_secret_df5a806da22235b6d93bcd62
external_data:
client_secret: secret_123
- created_at: '2026-03-17T13:31:45.722Z'
- updated_at: '2026-03-17T13:31:45.722Z'
+ created_at: '2026-03-19T15:42:40.174Z'
+ updated_at: '2026-03-19T15:42:40.174Z'
payment_method_id: pm_UkLWZg9DAJ
payment_source_id:
payment_source_type:
@@ -6883,12 +6878,12 @@ paths:
example:
id: pss_UkLWZg9DAJ
status: completed
- external_id: seti_test_2c35ad9cf75115b3ff052b35
- external_client_secret: seti_secret_0cb8754bfacba149b9a2dc17
+ external_id: seti_test_e0c0486f1dff5069a89eb47b
+ external_client_secret: seti_secret_c22967b01f1f166fdd42552f
external_data:
client_secret: secret_123
- created_at: '2026-03-17T13:31:46.826Z'
- updated_at: '2026-03-17T13:31:46.840Z'
+ created_at: '2026-03-19T15:42:41.478Z'
+ updated_at: '2026-03-19T15:42:41.493Z'
payment_method_id: pm_UkLWZg9DAJ
payment_source_id: card_UkLWZg9DAJ
payment_source_type: Spree::CreditCard
@@ -6975,23 +6970,22 @@ paths:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
response_code: '12345'
- number: PY8ZTQQN
+ number: P47MB451
amount: '110.0'
display_amount: "$110.00"
- created_at: '2026-03-17T13:31:48.006Z'
- updated_at: '2026-03-17T13:31:48.006Z'
+ created_at: '2026-03-19T15:42:42.849Z'
+ updated_at: '2026-03-19T15:42:42.849Z'
status: checkout
source_type: credit_card
source_id: card_UkLWZg9DAJ
source:
id: card_UkLWZg9DAJ
- cc_type: visa
- last_digits: '1111'
+ brand: visa
+ last4: '1111'
month: 12
year: 2027
name: Spree Commerce
default: false
- gateway_payment_profile_id:
payment_method:
id: pm_UkLWZg9DAJ
name: Check
@@ -7066,11 +7060,11 @@ paths:
id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
response_code:
- number: P82H6TJC
+ number: P0V5UZ3M
amount: '110.0'
display_amount: "$110.00"
- created_at: '2026-03-17T13:31:48.637Z'
- updated_at: '2026-03-17T13:31:48.637Z'
+ created_at: '2026-03-19T15:42:43.633Z'
+ updated_at: '2026-03-19T15:42:43.633Z'
status: checkout
source_type:
source_id:
@@ -7228,20 +7222,19 @@ paths:
example:
data:
- id: prod_UkLWZg9DAJ
- name: Product 623014
+ name: Product 627814
description: |-
- Voluptatum non doloribus fugiat unde adipisci. Debitis natus molestiae cumque omnis ad. Repellendus quibusdam explicabo nobis veniam quas harum suscipit libero.
- Tempore reiciendis ipsa dolor inventore illum. Ut veniam minus hic velit vel. Officia soluta sequi nam tempore. Maxime officia esse repudiandae exercitationem. Quasi quisquam necessitatibus nemo fugiat at soluta explicabo.
- Ratione excepturi dignissimos tempore a recusandae sunt accusantium ex. Fuga ea dolore qui voluptatibus nihil. Nisi ipsum reprehenderit magnam perferendis nemo similique. Aliquam ratione sed eos et repellat id cupiditate nam.
- Similique saepe a sit adipisci illum cumque quae. Laborum a aliquid adipisci cupiditate officiis omnis perferendis. Nesciunt repellendus ab cumque ullam necessitatibus. Rem itaque similique quasi ullam. Expedita deleniti et possimus dolor quis.
- Quibusdam et odit cupiditate cumque voluptas dolorem illo accusantium. Aliquid dicta voluptatum eligendi odio quod. Libero eos officiis ipsa dicta. Labore dolorem eveniet repudiandae optio nemo.
- slug: product-623014
+ Cum tempora dolorem mollitia facere officia. Quos sint illum blanditiis vel atque pariatur incidunt cum. Quia officia aut incidunt dolore sapiente corrupti. Hic laudantium animi sunt quia at. Laudantium quod ex esse explicabo dignissimos nesciunt quibusdam voluptatum.
+ Quaerat quisquam maiores accusantium asperiores. Animi dolor nemo deserunt quisquam sequi deleniti et. Quia molestias id odio ratione. At blanditiis itaque inventore fugiat dolorum numquam. Ducimus maiores est dignissimos ad at eligendi.
+ At quos totam quod dolores. Fugit ullam earum adipisci nemo atque veritatis. Est distinctio voluptatum repellat similique. Nihil ducimus quaerat eligendi numquam debitis eius nemo dolor.
+ Animi facilis nobis eos ab. Soluta sequi dolorum illo aperiam rerum quibusdam. Laboriosam quod nemo consequatur delectus ad. Labore est mollitia expedita reiciendis. Libero rerum vel quo eligendi magni odio sunt inventore.
+ slug: product-627814
meta_description:
meta_keywords:
variant_count: 1
- available_on: '2025-03-17T13:31:49.320Z'
- created_at: '2026-03-17T13:31:49.339Z'
- updated_at: '2026-03-17T13:31:49.388Z'
+ available_on: '2025-03-19T15:42:44.374Z'
+ created_at: '2026-03-19T15:42:44.389Z'
+ updated_at: '2026-03-19T15:42:44.437Z'
purchasable: true
in_stock: false
backorderable: true
@@ -7261,20 +7254,19 @@ paths:
price_list_id:
original_price:
- id: prod_gbHJdmfrXB
- name: Product 635757
+ name: Product 636090
description: |-
- Eos numquam voluptas optio quis possimus libero. Cupiditate vel officiis neque quia magni. Ipsa delectus quae dolores iure repellat consequuntur amet. Suscipit minima inventore pariatur magnam fugit officia.
- Sed accusantium vitae sit doloribus. Est tempora quaerat aspernatur officia minima tempore ratione. Similique accusantium soluta ex a saepe animi. Reiciendis nulla harum rerum repellendus commodi. Eos hic praesentium dicta aspernatur nostrum dolorem.
- Quam aliquam maxime ipsa assumenda. Earum possimus officiis debitis reiciendis. Quaerat nisi tempora et corrupti eaque est earum. Suscipit dolore laudantium illo ipsa. Ab voluptatem totam id incidunt reiciendis temporibus quo architecto.
- Deserunt sint temporibus natus expedita dolorum. Molestiae at eos omnis sed ad nemo nisi placeat. Aut quasi aliquam praesentium vitae esse vero officia architecto.
- Ad amet natus accusamus vitae. Blanditiis nesciunt molestiae magni perspiciatis dolorem. Ea earum id dolorem laboriosam assumenda nobis. Sit recusandae quos non accusamus iusto nesciunt ipsa.
- slug: product-635757
+ Aspernatur deleniti iure quasi dicta ratione quidem debitis maxime. Repellat explicabo ipsam voluptates reiciendis impedit illo odit consectetur. Expedita eligendi ipsam aut laudantium libero eveniet similique ducimus. Et consectetur quis fugiat itaque. Facilis blanditiis nihil consequatur perspiciatis similique.
+ Quod qui et repellendus repellat. Cupiditate quisquam sapiente suscipit doloremque alias. Deserunt neque reiciendis quaerat maiores corrupti tempora sapiente. Animi ut debitis commodi laudantium alias deserunt.
+ Suscipit ullam eius sunt inventore esse quis amet quia. Consequuntur neque quo aliquam dolores. Dolorum tempore labore sint animi. Expedita quia magni quos labore ut fugiat.
+ Praesentium quia rerum mollitia explicabo facilis. Maiores repellendus natus temporibus laborum expedita aspernatur. Corporis exercitationem magni est a voluptatibus.
+ slug: product-636090
meta_description:
meta_keywords:
variant_count: 0
- available_on: '2025-03-17T13:31:49.395Z'
- created_at: '2026-03-17T13:31:49.406Z'
- updated_at: '2026-03-17T13:31:49.422Z'
+ available_on: '2025-03-19T15:42:44.442Z'
+ created_at: '2026-03-19T15:42:44.451Z'
+ updated_at: '2026-03-19T15:42:44.466Z'
purchasable: true
in_stock: false
backorderable: true
@@ -7380,20 +7372,18 @@ paths:
application/json:
example:
id: prod_UkLWZg9DAJ
- name: Product 741721
+ name: Product 7448
description: |-
- Minima fugit laborum nihil aliquam voluptatem eius adipisci. Laboriosam voluptate ipsum laudantium nesciunt. Ipsa rem molestias iure ex est temporibus deleniti numquam.
- Eum animi ipsum libero nihil quisquam quas culpa. Repellat facere velit quasi autem. Fugiat suscipit eius adipisci laborum.
- Necessitatibus quod reprehenderit cumque provident quia aut. Similique ad recusandae non magnam officiis nostrum eaque. Iste mollitia non neque blanditiis asperiores facilis. Rerum dolore enim mollitia molestiae deserunt porro.
- Dolor deleniti cum autem laboriosam occaecati delectus non blanditiis. Quaerat earum nisi commodi occaecati dolor. Maiores sit voluptatum possimus sequi esse.
- Eius voluptatem expedita dignissimos odit. Vero rerum quasi quidem repudiandae dolor odio. Deserunt repellendus nihil in magnam laudantium.
- slug: product-741721
+ Pariatur sequi vero eaque similique. Perferendis beatae minima numquam necessitatibus consectetur. Quis nihil hic libero occaecati cupiditate aliquam omnis ducimus. Magni dolor ullam ad amet accusamus. Nisi excepturi laboriosam ad esse debitis temporibus.
+ Molestiae placeat est quas accusantium blanditiis doloremque hic fuga. Eveniet esse fugit similique ex accusantium provident sunt quam. Maxime optio voluptatibus porro expedita. Corrupti nostrum itaque cumque voluptate labore asperiores voluptates reprehenderit.
+ Fugiat expedita natus molestias occaecati tempora neque quam. Iusto temporibus necessitatibus esse tenetur veritatis deleniti consectetur harum. Perspiciatis ipsa impedit nesciunt fuga.
+ slug: product-7448
meta_description:
meta_keywords:
variant_count: 1
- available_on: '2025-03-17T13:31:50.030Z'
- created_at: '2026-03-17T13:31:50.058Z'
- updated_at: '2026-03-17T13:31:50.102Z'
+ available_on: '2025-03-19T15:42:45.066Z'
+ created_at: '2026-03-19T15:42:45.081Z'
+ updated_at: '2026-03-19T15:42:45.118Z'
purchasable: true
in_stock: false
backorderable: true
@@ -7492,11 +7482,11 @@ paths:
- id: opt_UkLWZg9DAJ
type: option
name: size
- presentation: Size
+ label: Size
options:
- id: optval_UkLWZg9DAJ
name: small
- presentation: S
+ label: S
position: 1
count: 1
- id: categories
@@ -7615,19 +7605,19 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R603145577
- token: nhuCGHm3NS2fn55nGW77n3SqF5ZFoo7MDXJ
- special_instructions:
+ number: R900769334
+ token: 9ASU3PM6UYpYGUKXXQ1g7TDunkSpWqRfLsT
+ customer_note:
currency: USD
locale: en
- item_count: 1
+ total_quantity: 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"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -7636,21 +7626,21 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-17T13:31:52.072Z'
- updated_at: '2026-03-17T13:31:52.122Z'
delivery_total: '100.0'
display_delivery_total: "$100.00"
+ created_at: '2026-03-19T15:42:47.093Z'
+ updated_at: '2026-03-19T15:42:47.140Z'
current_step: address
completed_steps: []
requirements: []
- promotions: []
+ discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 1027725
- slug: product-1027725
+ name: Product 1022751
+ slug: product-1022751
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -7662,28 +7652,28 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_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-17T13:31:52.100Z'
- updated_at: '2026-03-17T13:31:52.100Z'
+ created_at: '2026-03-19T15:42:47.121Z'
+ updated_at: '2026-03-19T15:42:47.121Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H80881646234
+ number: H16042975438
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-17T13:31:52.105Z'
- updated_at: '2026-03-17T13:31:52.119Z'
+ created_at: '2026-03-19T15:42:47.126Z'
+ updated_at: '2026-03-19T15:42:47.138Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -7698,7 +7688,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_262
- name: Ezra Jerde
+ name: Lachelle Langosh
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -7719,12 +7709,12 @@ paths:
payments:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- response_code: 1-SC-20260317133152444067
- number: PR7UTZEL
+ response_code: 1-SC-20260319154247443266
+ number: P96ANHJS
amount: '10.0'
display_amount: "$10.00"
- created_at: '2026-03-17T13:31:52.448Z'
- updated_at: '2026-03-17T13:31:52.448Z'
+ created_at: '2026-03-19T15:42:47.446Z'
+ updated_at: '2026-03-19T15:42:47.446Z'
status: checkout
source_type: store_credit
source_id: credit_UkLWZg9DAJ
@@ -7743,15 +7733,15 @@ paths:
description: Store Credit
type: Spree::PaymentMethod::StoreCredit
session_required: false
- bill_address:
+ billing_address:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 244 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -7760,15 +7750,15 @@ paths:
state_abbr: STATE_ABBR_264
quick_checkout: false
state_name: STATE_NAME_264
- ship_address:
+ shipping_address:
id: addr_VqXmZF31wY
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 245 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -7856,19 +7846,19 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R763668804
- token: ju4W396u9wfnVBmEmjRuXFmkFea6T3qh6c7
- special_instructions:
+ number: R664340384
+ token: KyuFZ2NTmYfWcXYGcnNA31JPGYbCrzPnHtu
+ customer_note:
currency: USD
locale: en
- item_count: 1
+ total_quantity: 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"
+ discount_total: '0.0'
+ display_discount_total: "$0.00"
tax_total: '0.0'
display_tax_total: "$0.00"
included_tax_total: '0.0'
@@ -7877,24 +7867,24 @@ paths:
display_additional_tax_total: "$0.00"
total: '110.0'
display_total: "$110.00"
- created_at: '2026-03-17T13:31:53.645Z'
- updated_at: '2026-03-17T13:31:53.735Z'
delivery_total: '100.0'
display_delivery_total: "$100.00"
+ created_at: '2026-03-19T15:42:48.670Z'
+ updated_at: '2026-03-19T15:42:48.755Z'
current_step: address
completed_steps: []
requirements:
- step: payment
field: payment
message: Add a payment method
- promotions: []
+ discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 1048280
- slug: product-1048280
+ name: Product 1041805
+ slug: product-1041805
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -7906,28 +7896,28 @@ paths:
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"
+ discount_total: '0.0'
+ display_discount_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-17T13:31:53.689Z'
- updated_at: '2026-03-17T13:31:53.689Z'
+ created_at: '2026-03-19T15:42:48.726Z'
+ updated_at: '2026-03-19T15:42:48.726Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H78102974840
+ number: H01872572708
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-17T13:31:53.701Z'
- updated_at: '2026-03-17T13:31:53.730Z'
+ created_at: '2026-03-19T15:42:48.733Z'
+ updated_at: '2026-03-19T15:42:48.751Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -7942,7 +7932,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_270
- name: Remedios Bradtke
+ name: Britt Leffler
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -7961,15 +7951,15 @@ paths:
name: UPS Ground
code: UPS_GROUND
payments: []
- bill_address:
+ billing_address:
id: addr_EfhxLZ9ck8
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 252 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -7978,15 +7968,15 @@ paths:
state_abbr: STATE_ABBR_272
quick_checkout: false
state_name: STATE_NAME_272
- ship_address:
+ shipping_address:
id: addr_VqXmZF31wY
- firstname: John
- lastname: Doe
+ first_name: John
+ last_name: Doe
full_name: John Doe
address1: 253 Lovely Street
address2: Northwest
+ postal_code: '35005'
city: Herndon
- zipcode: '35005'
phone: 555-555-0199
company: Company
country_name: United States of America
@@ -8058,9 +8048,9 @@ paths:
data:
- id: wl_UkLWZg9DAJ
name: My Wishlist
- token: b2FWPXMe1zYUt44v5b844iMd
- created_at: '2026-03-17T13:31:54.386Z'
- updated_at: '2026-03-17T13:31:54.386Z'
+ token: o7wfyLDDSJGtYnWpTdCV1VWB
+ created_at: '2026-03-19T15:42:49.357Z'
+ updated_at: '2026-03-19T15:42:49.357Z'
is_default: false
is_private: true
meta:
@@ -8136,9 +8126,9 @@ paths:
example:
id: wl_gbHJdmfrXB
name: Birthday Ideas
- token: 6SUAvk35qCyNReLdDkEdqajK
- created_at: '2026-03-17T13:31:55.809Z'
- updated_at: '2026-03-17T13:31:55.809Z'
+ token: miR8E1qcE6zoGWMVzfjDqN8T
+ created_at: '2026-03-19T15:42:50.603Z'
+ updated_at: '2026-03-19T15:42:50.603Z'
is_default: false
is_private: true
schema:
@@ -8234,9 +8224,9 @@ paths:
example:
id: wl_UkLWZg9DAJ
name: My Wishlist
- token: SikYNpQzsrATdQFECHcEREjE
- created_at: '2026-03-17T13:31:56.958Z'
- updated_at: '2026-03-17T13:31:56.958Z'
+ token: cNjSkMkV2YftzcrTVRVe9qoF
+ created_at: '2026-03-19T15:42:51.770Z'
+ updated_at: '2026-03-19T15:42:51.770Z'
is_default: false
is_private: true
schema:
@@ -8298,9 +8288,9 @@ paths:
example:
id: wl_UkLWZg9DAJ
name: Updated Name
- token: wPW3f7PtPeEMYC2ViaERbRxN
- created_at: '2026-03-17T13:31:58.314Z'
- updated_at: '2026-03-17T13:31:58.419Z'
+ token: bU2G3yZuQWK5AjmPPoLp2FoD
+ created_at: '2026-03-19T15:42:53.082Z'
+ updated_at: '2026-03-19T15:42:53.127Z'
is_default: false
is_private: true
schema:
@@ -8412,8 +8402,8 @@ paths:
variant_id: variant_gbHJdmfrXB
wishlist_id: wl_UkLWZg9DAJ
quantity: 1
- created_at: '2026-03-17T13:31:59.669Z'
- updated_at: '2026-03-17T13:31:59.669Z'
+ created_at: '2026-03-19T15:42:54.359Z'
+ updated_at: '2026-03-19T15:42:54.359Z'
variant:
id: variant_gbHJdmfrXB
product_id: prod_gbHJdmfrXB
@@ -8421,8 +8411,8 @@ paths:
options_text: ''
track_inventory: true
media_count: 0
- created_at: '2026-03-17T13:31:59.643Z'
- updated_at: '2026-03-17T13:31:59.652Z'
+ created_at: '2026-03-19T15:42:54.328Z'
+ updated_at: '2026-03-19T15:42:54.339Z'
thumbnail_url:
purchasable: true
in_stock: false
@@ -8444,7 +8434,7 @@ paths:
original_price:
option_values: []
schema:
- "$ref": "#/components/schemas/WishedItem"
+ "$ref": "#/components/schemas/WishlistItem"
requestBody:
content:
application/json:
@@ -8721,10 +8711,10 @@ components:
properties:
id:
type: string
- firstname:
+ first_name:
type: string
nullable: true
- lastname:
+ last_name:
type: string
nullable: true
full_name:
@@ -8735,10 +8725,10 @@ components:
address2:
type: string
nullable: true
- city:
+ postal_code:
type: string
nullable: true
- zipcode:
+ city:
type: string
nullable: true
phone:
@@ -8764,13 +8754,13 @@ components:
nullable: true
required:
- id
- - firstname
- - lastname
+ - first_name
+ - last_name
- full_name
- address1
- address2
+ - postal_code
- city
- - zipcode
- phone
- company
- country_name
@@ -8780,38 +8770,6 @@ components:
- quick_checkout
- state_name
x-typelizer: true
- Asset:
- type: object
- properties:
- id:
- type: string
- viewable_id:
- type: string
- type:
- type: string
- nullable: true
- viewable_type:
- type: string
- position:
- type: number
- nullable: true
- alt:
- type: string
- nullable: true
- created_at:
- type: string
- updated_at:
- type: string
- required:
- - id
- - viewable_id
- - type
- - viewable_type
- - position
- - alt
- - created_at
- - updated_at
- x-typelizer: true
Base:
type: object
properties:
@@ -8820,34 +8778,6 @@ components:
required:
- id
x-typelizer: true
- CartPromotion:
- type: object
- properties:
- id:
- type: string
- promotion_id:
- type: string
- name:
- type: string
- description:
- type: string
- nullable: true
- code:
- type: string
- nullable: true
- amount:
- type: string
- display_amount:
- type: string
- required:
- - id
- - promotion_id
- - name
- - description
- - code
- - amount
- - display_amount
- x-typelizer: true
Cart:
type: object
properties:
@@ -8860,7 +8790,7 @@ components:
email:
type: string
nullable: true
- special_instructions:
+ customer_note:
type: string
nullable: true
currency:
@@ -8868,7 +8798,7 @@ components:
locale:
type: string
nullable: true
- item_count:
+ total_quantity:
type: number
item_total:
type: string
@@ -8878,9 +8808,9 @@ components:
type: string
display_adjustment_total:
type: string
- promo_total:
+ discount_total:
type: string
- display_promo_total:
+ display_discount_total:
type: string
tax_total:
type: string
@@ -8898,14 +8828,14 @@ components:
type: string
display_total:
type: string
- created_at:
- type: string
- updated_at:
- type: string
delivery_total:
type: string
display_delivery_total:
type: string
+ created_at:
+ type: string
+ updated_at:
+ type: string
current_step:
type: string
completed_steps:
@@ -8916,10 +8846,10 @@ components:
type: array
items:
"$ref": "#/components/schemas/CheckoutRequirement"
- promotions:
+ discounts:
type: array
items:
- "$ref": "#/components/schemas/CartPromotion"
+ "$ref": "#/components/schemas/Discount"
items:
type: array
items:
@@ -8932,11 +8862,11 @@ components:
type: array
items:
"$ref": "#/components/schemas/Payment"
- bill_address:
+ billing_address:
allOf:
- "$ref": "#/components/schemas/Address"
nullable: true
- ship_address:
+ shipping_address:
allOf:
- "$ref": "#/components/schemas/Address"
nullable: true
@@ -8949,16 +8879,16 @@ components:
- number
- token
- email
- - special_instructions
+ - customer_note
- currency
- locale
- - item_count
+ - total_quantity
- item_total
- display_item_total
- adjustment_total
- display_adjustment_total
- - promo_total
- - display_promo_total
+ - discount_total
+ - display_discount_total
- tax_total
- display_tax_total
- included_tax_total
@@ -8967,19 +8897,19 @@ components:
- display_additional_tax_total
- total
- display_total
- - created_at
- - updated_at
- delivery_total
- display_delivery_total
+ - created_at
+ - updated_at
- current_step
- completed_steps
- requirements
- - promotions
+ - discounts
- items
- fulfillments
- payments
- - bill_address
- - ship_address
+ - billing_address
+ - shipping_address
- payment_methods
x-typelizer: true
Category:
@@ -9097,9 +9027,9 @@ components:
properties:
id:
type: string
- cc_type:
+ brand:
type: string
- last_digits:
+ last4:
type: string
month:
type: number
@@ -9110,18 +9040,14 @@ components:
nullable: true
default:
type: boolean
- gateway_payment_profile_id:
- type: string
- nullable: true
required:
- id
- - cc_type
- - last_digits
+ - brand
+ - last4
- month
- year
- name
- default
- - gateway_payment_profile_id
x-typelizer: true
Currency:
type: object
@@ -9137,27 +9063,6 @@ components:
- name
- symbol
x-typelizer: true
- CustomerReturn:
- type: object
- properties:
- id:
- type: string
- number:
- type: string
- created_at:
- type: string
- updated_at:
- type: string
- stock_location_id:
- type: string
- nullable: true
- required:
- - id
- - number
- - created_at
- - updated_at
- - stock_location_id
- x-typelizer: true
Customer:
type: object
properties:
@@ -9299,34 +9204,33 @@ components:
- updated_at
- variant_id
x-typelizer: true
- Export:
+ Discount:
type: object
properties:
id:
type: string
- number:
+ promotion_id:
type: string
- type:
+ name:
type: string
- nullable: true
- format:
+ description:
type: string
nullable: true
- created_at:
+ code:
type: string
- updated_at:
+ nullable: true
+ amount:
type: string
- user_id:
+ display_amount:
type: string
- nullable: true
required:
- id
- - number
- - type
- - format
- - created_at
- - updated_at
- - user_id
+ - promotion_id
+ - name
+ - description
+ - code
+ - amount
+ - display_amount
x-typelizer: true
Fulfillment:
type: object
@@ -9480,109 +9384,35 @@ components:
- created_at
- updated_at
x-typelizer: true
- ImportRow:
+ Invitation:
type: object
properties:
id:
type: string
- row_number:
- type: number
- status:
- type: string
- validation_errors:
- type: object
- item_type:
- type: string
- nullable: true
- created_at:
- type: string
- updated_at:
+ email:
type: string
- import_id:
+ resource_type:
type: string
nullable: true
- item_id:
+ inviter_type:
type: string
nullable: true
- required:
- - id
- - row_number
- - status
- - validation_errors
- - item_type
- - created_at
- - updated_at
- - import_id
- - item_id
- x-typelizer: true
- Import:
- type: object
- properties:
- id:
- type: string
- number:
- type: string
- type:
+ invitee_type:
type: string
nullable: true
- rows_count:
- type: number
created_at:
type: string
updated_at:
type: string
status:
type: string
- owner_type:
+ resource_id:
type: string
nullable: true
- owner_id:
+ inviter_id:
type: string
nullable: true
- user_id:
- type: string
- nullable: true
- required:
- - id
- - number
- - type
- - rows_count
- - created_at
- - updated_at
- - status
- - owner_type
- - owner_id
- - user_id
- x-typelizer: true
- Invitation:
- type: object
- properties:
- id:
- type: string
- email:
- type: string
- resource_type:
- type: string
- nullable: true
- inviter_type:
- type: string
- nullable: true
- invitee_type:
- type: string
- nullable: true
- created_at:
- type: string
- updated_at:
- type: string
- status:
- type: string
- resource_id:
- type: string
- nullable: true
- inviter_id:
- type: string
- nullable: true
- invitee_id:
+ invitee_id:
type: string
nullable: true
role_id:
@@ -9647,9 +9477,9 @@ components:
type: string
display_included_tax_total:
type: string
- promo_total:
+ discount_total:
type: string
- display_promo_total:
+ display_discount_total:
type: string
pre_tax_amount:
type: string
@@ -9698,8 +9528,8 @@ components:
- display_additional_tax_total
- included_tax_total
- display_included_tax_total
- - promo_total
- - display_promo_total
+ - discount_total
+ - display_discount_total
- pre_tax_amount
- display_pre_tax_amount
- discounted_amount
@@ -9883,14 +9713,14 @@ components:
type: string
name:
type: string
- presentation:
+ label:
type: string
position:
type: number
required:
- id
- name
- - presentation
+ - label
- position
x-typelizer: true
OptionValue:
@@ -9902,50 +9732,22 @@ components:
type: string
name:
type: string
- presentation:
+ label:
type: string
position:
type: number
option_type_name:
type: string
- option_type_presentation:
+ option_type_label:
type: string
required:
- id
- option_type_id
- name
- - presentation
+ - label
- position
- option_type_name
- - option_type_presentation
- x-typelizer: true
- OrderPromotion:
- type: object
- properties:
- id:
- type: string
- promotion_id:
- type: string
- name:
- type: string
- description:
- type: string
- nullable: true
- code:
- type: string
- nullable: true
- amount:
- type: string
- display_amount:
- type: string
- required:
- - id
- - promotion_id
- - name
- - description
- - code
- - amount
- - display_amount
+ - option_type_label
x-typelizer: true
Order:
type: object
@@ -9956,7 +9758,7 @@ components:
type: string
email:
type: string
- special_instructions:
+ customer_note:
type: string
nullable: true
currency:
@@ -9964,7 +9766,7 @@ components:
locale:
type: string
nullable: true
- item_count:
+ total_quantity:
type: number
item_total:
type: string
@@ -9974,9 +9776,9 @@ components:
type: string
display_adjustment_total:
type: string
- promo_total:
+ discount_total:
type: string
- display_promo_total:
+ display_discount_total:
type: string
tax_total:
type: string
@@ -9994,12 +9796,9 @@ components:
type: string
display_total:
type: string
- completed_at:
- type: string
- nullable: true
- created_at:
+ delivery_total:
type: string
- updated_at:
+ display_delivery_total:
type: string
fulfillment_status:
type: string
@@ -10007,14 +9806,17 @@ components:
payment_status:
type: string
nullable: true
- delivery_total:
+ completed_at:
type: string
- display_delivery_total:
+ nullable: true
+ created_at:
+ type: string
+ updated_at:
type: string
- promotions:
+ discounts:
type: array
items:
- "$ref": "#/components/schemas/OrderPromotion"
+ "$ref": "#/components/schemas/Discount"
items:
type: array
items:
@@ -10027,11 +9829,11 @@ components:
type: array
items:
"$ref": "#/components/schemas/Payment"
- bill_address:
+ billing_address:
allOf:
- "$ref": "#/components/schemas/Address"
nullable: true
- ship_address:
+ shipping_address:
allOf:
- "$ref": "#/components/schemas/Address"
nullable: true
@@ -10039,16 +9841,16 @@ components:
- id
- number
- email
- - special_instructions
+ - customer_note
- currency
- locale
- - item_count
+ - total_quantity
- item_total
- display_item_total
- adjustment_total
- display_adjustment_total
- - promo_total
- - display_promo_total
+ - discount_total
+ - display_discount_total
- tax_total
- display_tax_total
- included_tax_total
@@ -10057,19 +9859,19 @@ components:
- display_additional_tax_total
- total
- display_total
+ - delivery_total
+ - display_delivery_total
+ - fulfillment_status
+ - payment_status
- completed_at
- created_at
- updated_at
- - fulfillment_status
- - payment_status
- - delivery_total
- - display_delivery_total
- - promotions
+ - discounts
- items
- fulfillments
- payments
- - bill_address
- - ship_address
+ - billing_address
+ - shipping_address
x-typelizer: true
PaymentMethod:
type: object
@@ -10247,12 +10049,8 @@ components:
properties:
id:
type: string
- gateway_payment_profile_id:
- type: string
- nullable: true
required:
- id
- - gateway_payment_profile_id
x-typelizer: true
Price:
type: object
@@ -10402,63 +10200,11 @@ components:
code:
type: string
nullable: true
- type:
- type: string
- nullable: true
- kind:
- type: string
- nullable: true
- path:
- type: string
- nullable: true
- match_policy:
- type: string
- nullable: true
- usage_limit:
- type: number
- nullable: true
- advertise:
- type: boolean
- multi_codes:
- type: boolean
- code_prefix:
- type: string
- nullable: true
- number_of_codes:
- type: number
- nullable: true
- starts_at:
- type: string
- nullable: true
- expires_at:
- type: string
- nullable: true
- created_at:
- type: string
- updated_at:
- type: string
- promotion_category_id:
- type: string
- nullable: true
required:
- id
- name
- description
- code
- - type
- - kind
- - path
- - match_policy
- - usage_limit
- - advertise
- - multi_codes
- - code_prefix
- - number_of_codes
- - starts_at
- - expires_at
- - created_at
- - updated_at
- - promotion_category_id
x-typelizer: true
Refund:
type: object
@@ -10494,73 +10240,6 @@ components:
- refund_reason_id
- reimbursement_id
x-typelizer: true
- Reimbursement:
- type: object
- properties:
- id:
- type: string
- number:
- type: string
- reimbursement_status:
- type: string
- nullable: true
- created_at:
- type: string
- updated_at:
- type: string
- total:
- type: string
- nullable: true
- order_id:
- type: string
- nullable: true
- customer_return_id:
- type: string
- nullable: true
- required:
- - id
- - number
- - reimbursement_status
- - created_at
- - updated_at
- - total
- - order_id
- - customer_return_id
- x-typelizer: true
- Report:
- type: object
- properties:
- id:
- type: string
- type:
- type: string
- nullable: true
- currency:
- type: string
- nullable: true
- created_at:
- type: string
- updated_at:
- type: string
- user_id:
- type: string
- nullable: true
- date_from:
- type: string
- nullable: true
- date_to:
- type: string
- nullable: true
- required:
- - id
- - type
- - currency
- - created_at
- - updated_at
- - user_id
- - date_from
- - date_to
- x-typelizer: true
ReturnAuthorization:
type: object
properties:
@@ -10572,7 +10251,7 @@ components:
type: string
updated_at:
type: string
- state:
+ status:
type: string
order_id:
type: string
@@ -10588,7 +10267,7 @@ components:
- number
- created_at
- updated_at
- - state
+ - status
- order_id
- stock_location_id
- return_authorization_reason_id
@@ -10647,17 +10326,6 @@ components:
- reimbursement_id
- exchange_variant_id
x-typelizer: true
- ShippingCategory:
- type: object
- properties:
- id:
- type: string
- name:
- type: string
- required:
- - id
- - name
- x-typelizer: true
State:
type: object
properties:
@@ -10669,34 +10337,6 @@ components:
- abbr
- name
x-typelizer: true
- StockItem:
- type: object
- properties:
- id:
- type: string
- count_on_hand:
- type: number
- backorderable:
- type: boolean
- created_at:
- type: string
- updated_at:
- type: string
- stock_location_id:
- type: string
- nullable: true
- variant_id:
- type: string
- nullable: true
- required:
- - id
- - count_on_hand
- - backorderable
- - created_at
- - updated_at
- - stock_location_id
- - variant_id
- x-typelizer: true
StockLocation:
type: object
properties:
@@ -10736,73 +10376,6 @@ components:
- country_name
- state_text
x-typelizer: true
- StockMovement:
- type: object
- properties:
- id:
- type: string
- quantity:
- type: number
- action:
- type: string
- nullable: true
- originator_type:
- type: string
- nullable: true
- created_at:
- type: string
- updated_at:
- type: string
- originator_id:
- type: string
- nullable: true
- stock_item_id:
- type: string
- nullable: true
- required:
- - id
- - quantity
- - action
- - originator_type
- - created_at
- - updated_at
- - originator_id
- - stock_item_id
- x-typelizer: true
- StockTransfer:
- type: object
- properties:
- id:
- type: string
- number:
- type: string
- nullable: true
- type:
- type: string
- nullable: true
- reference:
- type: string
- nullable: true
- created_at:
- type: string
- updated_at:
- type: string
- source_location_id:
- type: string
- nullable: true
- destination_location_id:
- type: string
- nullable: true
- required:
- - id
- - number
- - type
- - reference
- - created_at
- - updated_at
- - source_location_id
- - destination_location_id
- x-typelizer: true
StoreCredit:
type: object
properties:
@@ -10832,17 +10405,6 @@ components:
- display_amount_remaining
- currency
x-typelizer: true
- TaxCategory:
- type: object
- properties:
- id:
- type: string
- name:
- type: string
- required:
- - id
- - name
- x-typelizer: true
Variant:
type: object
properties:
@@ -10925,7 +10487,7 @@ components:
- original_price
- option_values
x-typelizer: true
- WishedItem:
+ WishlistItem:
type: object
properties:
id:
@@ -10971,7 +10533,7 @@ components:
items:
type: array
items:
- "$ref": "#/components/schemas/WishedItem"
+ "$ref": "#/components/schemas/WishlistItem"
required:
- id
- name
diff --git a/docs/plans/5.x-store-api-naming-standardization.md b/docs/plans/5.x-store-api-naming-standardization.md
new file mode 100644
index 0000000000..f393a4a21c
--- /dev/null
+++ b/docs/plans/5.x-store-api-naming-standardization.md
@@ -0,0 +1,233 @@
+# Store API Naming Standardization
+
+**Status:** In Progress
+**Target:** Spree 5.4 (API surface + model aliases); Spree 6.0 (database columns/tables)
+**Depends on:** `5.x-store-api-bridges.md` (same pattern: rename API surface now, models/DB later)
+**Author:** Damian + Claude
+**Last updated:** 2026-03-19
+
+## Summary
+
+Standardize Spree Store API entity and attribute names against industry conventions (Shopify, Medusa, Saleor, Vendure, BigCommerce, commercetools). Changes follow the established bridge pattern: rename serializers, controllers, and add model aliases now (5.4), defer database column/table renames to 6.0.
+
+## Key Decisions (do not deviate without discussion)
+
+- All changes are **breaking** in the Store API — no backward compatibility, new names only (same approach as `5.x-store-api-bridges.md`)
+- Models get **alias accessors** for new names pointing to old columns — serializers and services use the new names directly
+- Database column/table renames are deferred to **6.0**
+- Controllers accept **new param names only** — no backward compat for old names
+
+## Changes
+
+### 1. Address: `ship_address` / `bill_address` → `shipping_address` / `billing_address`
+
+**Serializers:** Cart and Order serializers use `key: :billing_address` / `key: :shipping_address` on the association.
+
+**Controllers:** Cart update accepts `shipping_address_id`, `billing_address_id`, `shipping_address: {}`, `billing_address: {}`.
+
+**Service:** `Carts::Update` uses `assign_address(:shipping_address)` / `:billing_address` directly.
+
+**Model aliases (already existed + new):**
+- `alias_method :billing_address, :bill_address` (existed)
+- `alias_method :shipping_address, :ship_address` (existed)
+- `alias_attribute :billing_address_id, :bill_address_id` (new)
+- `alias_attribute :shipping_address_id, :ship_address_id` (new)
+- `alias shipping_address_attributes= ship_address_attributes=` (new)
+- `alias billing_address_attributes= bill_address_attributes=` (new)
+
+**6.0 database:** Rename `spree_orders.bill_address_id` → `billing_address_id`, `spree_orders.ship_address_id` → `shipping_address_id`
+
+### 2. Address: `firstname`/`lastname` → `first_name`/`last_name`
+
+**Serializer:** `AddressSerializer` exposes `first_name` / `last_name`.
+
+**Controllers:** Accept `first_name` / `last_name` only.
+
+**Model (already existed):** `Spree::Address` has `first_name` / `last_name` accessor methods and `Spree::PermittedAttributes` includes both forms.
+
+**6.0 database:** Rename `spree_addresses.firstname` → `first_name`, `spree_addresses.lastname` → `last_name`
+
+### 3. Address: `zipcode` → `postal_code`
+
+**Serializer:** `AddressSerializer` exposes `postal_code`.
+
+**Controllers:** Accept `postal_code` only.
+
+**Model (already existed):** `alias_attribute :postal_code, :zipcode` on `Spree::Address`.
+
+**6.0 database:** Rename `spree_addresses.zipcode` → `postal_code`
+
+### 4. CartPromotion/OrderPromotion → Discount
+
+**Serializers:**
+- Created `DiscountSerializer` (single serializer for both cart and order promotions)
+- Deleted `CartPromotionSerializer` and `OrderPromotionSerializer` files
+- Cart/Order serializers: `key: :discounts` on the association
+- Admin: `Admin::DiscountSerializer` replaces `Admin::OrderPromotionSerializer`
+
+**Model aliases:** `alias discounts order_promotions` on `Spree::Order`
+
+**Dependencies:** `discount_serializer`, `cart_promotion_serializer`, `order_promotion_serializer` all point to `DiscountSerializer`. Admin: `admin_discount_serializer` and `admin_order_promotion_serializer` point to `Admin::DiscountSerializer`.
+
+**TypeScript type:** `CartPromotion` / `OrderPromotion` → `Discount`
+
+### 5. `promo_total` → `discount_total`
+
+**Serializers:** Cart, Order, LineItem serializers expose `discount_total` / `display_discount_total`.
+
+**Model aliases:**
+- `Spree::Order`: `alias_attribute :discount_total, :promo_total`, `alias display_discount_total display_promo_total`
+- `Spree::LineItem`: `alias_attribute :discount_total, :promo_total`, `alias display_discount_total display_promo_total`
+
+**6.0 database:** Rename `spree_orders.promo_total` → `discount_total`, `spree_line_items.promo_total` → `discount_total`
+
+### 6. WishedItem → WishlistItem
+
+**Serializers:** Created `WishlistItemSerializer`, `WishlistSerializer` references it. Old `WishedItemSerializer` kept for now (dependency points to new one).
+
+**Model alias:** `alias wishlist_items wished_items` on `Spree::Wishlist`
+
+**Dependencies:** `wishlist_item_serializer` and `wished_item_serializer` both point to `WishlistItemSerializer`.
+
+**6.0 database/model:** Rename `Spree::WishedItem` → `Spree::WishlistItem`, table `spree_wished_items` → `spree_wishlist_items`, prefix `wi_` → `wli_`
+
+### 7. `special_instructions` → `customer_note`
+
+**Serializers:** Cart and Order serializers expose `customer_note`.
+
+**Controller:** Cart update accepts `customer_note` only.
+
+**Service:** `Carts::Update` assigns `cart.customer_note`.
+
+**Model alias:** `alias_attribute :customer_note, :special_instructions` on `Spree::Order`
+
+**6.0 database:** Rename `spree_orders.special_instructions` → `customer_note`
+
+### 8. OptionType/OptionValue: `presentation` → `label`
+
+**Serializers:** `OptionTypeSerializer` and `OptionValueSerializer` expose `label`. `OptionValueSerializer` exposes `option_type_label`.
+
+**Model aliases:** `alias_attribute :label, :presentation` on both `Spree::OptionType` and `Spree::OptionValue`
+
+**6.0 database:** Rename `spree_option_types.presentation` → `label`, `spree_option_values.presentation` → `label`
+
+### 9. Remove Asset serializer from Store API
+
+`AssetSerializer` excluded from Store SDK types via Typelizer `reject_class` filter. `Media` serializer is the correct Store-facing entity.
+
+### 10. Exclude admin-only schemas from Store API types
+
+Added Typelizer `reject_class` filter excluding serializers with no Store API controller:
+`Asset`, `CartPromotion`, `OrderPromotion`, `StockItem`, `StockMovement`, `StockTransfer`, `ShippingCategory`, `Reimbursement`, `Report`, `Export`, `Import`, `ImportRow`, `TaxCategory`, `CustomerReturn`
+
+### 11. Slim down Promotion serializer for Store API
+
+`PromotionSerializer` reduced to: `id`, `name`, `description`, `code`. Full promotion details remain in Admin serializer only.
+
+### 12. CreditCard: `cc_type` → `brand`, `last_digits` → `last4`
+
+**Serializer:** `CreditCardSerializer` exposes `brand` and `last4`.
+
+**Model aliases:**
+- `alias_attribute :brand, :cc_type` (already existed)
+- `alias_attribute :last4, :last_digits` (new)
+
+**6.0 database:** Rename `spree_credit_cards.cc_type` → `brand`, `spree_credit_cards.last_digits` → `last4`
+
+### 13. Remove `gateway_payment_profile_id` from Store API
+
+Removed from `CreditCardSerializer` and `PaymentSourceSerializer`. Added to `Admin::CreditCardSerializer` and `Admin::PaymentSourceSerializer`.
+
+### 14. `item_count` → `total_quantity`
+
+**Serializers:** Cart and Order serializers expose `total_quantity`.
+
+**Model alias:** `alias_attribute :total_quantity, :item_count` on `Spree::Order`
+
+**6.0 database:** Rename `spree_orders.item_count` → `total_quantity`
+
+### 15. ReturnAuthorization: `state` → `status`
+
+**Serializer:** `ReturnAuthorizationSerializer` exposes `status` (reads `object.state`).
+
+**6.0 database:** Covered by `6.0-normalize-state-to-status.md`
+
+### 16. Additional Order model aliases (from 5.x-store-api-bridges)
+
+These aliases consolidate all naming bridges on `Spree::Order`:
+- `alias fulfillments shipments`
+- `alias_attribute :delivery_total, :shipment_total`
+- `alias display_delivery_total display_shipment_total`
+- `alias_attribute :fulfillment_status, :shipment_state`
+- `alias_attribute :payment_status, :payment_state`
+
+## Implementation Status
+
+### Files created
+- `api/app/serializers/spree/api/v3/discount_serializer.rb`
+- `api/app/serializers/spree/api/v3/wishlist_item_serializer.rb`
+- `api/app/serializers/spree/api/v3/admin/discount_serializer.rb`
+
+### Files deleted
+- `api/app/serializers/spree/api/v3/cart_promotion_serializer.rb`
+- `api/app/serializers/spree/api/v3/order_promotion_serializer.rb`
+- `api/app/serializers/spree/api/v3/admin/order_promotion_serializer.rb`
+
+### Files modified
+- `api/app/serializers/spree/api/v3/address_serializer.rb` — `firstname`→`first_name`, `lastname`→`last_name`, `zipcode`→`postal_code`
+- `api/app/serializers/spree/api/v3/cart_serializer.rb` — all renames (customer_note, total_quantity, discount_total, billing/shipping_address, discounts)
+- `api/app/serializers/spree/api/v3/order_serializer.rb` — same as cart
+- `api/app/serializers/spree/api/v3/line_item_serializer.rb` — `promo_total`→`discount_total`
+- `api/app/serializers/spree/api/v3/option_type_serializer.rb` — `presentation`→`label`
+- `api/app/serializers/spree/api/v3/option_value_serializer.rb` — `presentation`→`label`, `option_type_presentation`→`option_type_label`
+- `api/app/serializers/spree/api/v3/credit_card_serializer.rb` — `cc_type`→`brand`, `last_digits`→`last4`, removed `gateway_payment_profile_id`
+- `api/app/serializers/spree/api/v3/payment_source_serializer.rb` — removed `gateway_payment_profile_id`
+- `api/app/serializers/spree/api/v3/return_authorization_serializer.rb` — `state`→`status`
+- `api/app/serializers/spree/api/v3/promotion_serializer.rb` — slimmed to name/description/code
+- `api/app/serializers/spree/api/v3/wishlist_serializer.rb` — references `wishlist_item_serializer`
+- `api/app/serializers/spree/api/v3/admin/order_serializer.rb` — discounts key, billing/shipping_address keys, admin_discount_serializer
+- `api/app/serializers/spree/api/v3/admin/credit_card_serializer.rb` — added `gateway_payment_profile_id`
+- `api/app/serializers/spree/api/v3/admin/payment_source_serializer.rb` — added `gateway_payment_profile_id`
+- `api/app/controllers/spree/api/v3/store/carts_controller.rb` — new param names only
+- `api/app/controllers/spree/api/v3/store/customer/addresses_controller.rb` — new param names only
+- `api/lib/spree/api/dependencies.rb` — added discount_serializer, wishlist_item_serializer, admin_discount_serializer
+- `api/config/initializers/typelizer.rb` — exclude admin-only schemas from Store types
+- `core/app/models/spree/order.rb` — all aliases (discount_total, customer_note, total_quantity, billing/shipping_address_id, discounts, fulfillments, etc.)
+- `core/app/models/spree/line_item.rb` — discount_total alias
+- `core/app/models/spree/option_type.rb` — label alias
+- `core/app/models/spree/option_value.rb` — label alias
+- `core/app/models/spree/credit_card.rb` — last4 alias
+- `core/app/models/spree/wishlist.rb` — wishlist_items alias
+- `core/app/services/spree/carts/update.rb` — uses new names (shipping_address, billing_address, customer_note)
+
+### Integration tests updated
+- `api/spec/integration/spree/api/v3/store/carts_spec.rb`
+- `api/spec/integration/spree/api/v3/store/addresses_spec.rb`
+- `api/spec/integration/spree/api/v3/store/credit_cards_spec.rb`
+
+### Test results
+- Backend integration tests: 149/149 pass
+
+### Still TODO
+- Regenerate TypeScript types (`bundle exec rake typelizer:generate`)
+- Regenerate Zod schemas (`cd packages/sdk && pnpm generate:zod`)
+- Update SDK client code and tests
+- Update Next.js package
+- Regenerate OpenAPI spec (`bundle exec rake rswag:specs:swaggerize`)
+- Update docs
+
+## Constraints on Current Work
+
+- All **new** Store API code must use the new naming from this plan
+- Admin API inherits Store serializer renames via inheritance — Admin serializer keys also use new names
+- SDK examples and docs must use new naming after this ships
+
+## Open Questions
+
+None — all decisions made.
+
+## References
+
+- `5.x-store-api-bridges.md` — prior art for this exact pattern
+- `6.0-normalize-state-to-status.md` — covers `state` → `status` DB rename
+- Industry comparison: Shopify, Medusa, Saleor, Vendure, BigCommerce, commercetools Storefront APIs
diff --git a/packages/admin-sdk/src/types/generated/Address.ts b/packages/admin-sdk/src/types/generated/Address.ts
index e7dce868e2..6b35f1509a 100644
--- a/packages/admin-sdk/src/types/generated/Address.ts
+++ b/packages/admin-sdk/src/types/generated/Address.ts
@@ -1,16 +1,16 @@
-// Typelizer digest 41755edff3c7f43176d1a4755677a9e4
+// Typelizer digest a2d05d283b85d7f9e138f5c783d8bb90
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
interface Address {
id: string;
- firstname: string | null;
- lastname: string | null;
+ first_name: string | null;
+ last_name: string | null;
full_name: string;
address1: string | null;
address2: string | null;
+ postal_code: string | null;
city: string | null;
- zipcode: string | null;
phone: string | null;
company: string | null;
country_name: string;
diff --git a/packages/admin-sdk/src/types/generated/CreditCard.ts b/packages/admin-sdk/src/types/generated/CreditCard.ts
index acc8059f69..1aaab61683 100644
--- a/packages/admin-sdk/src/types/generated/CreditCard.ts
+++ b/packages/admin-sdk/src/types/generated/CreditCard.ts
@@ -1,11 +1,11 @@
-// Typelizer digest e3c2906b962aa5abebff3b826af5700f
+// Typelizer digest 7af041661f6e70eb051d603e80c7a838
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
interface CreditCard {
id: string;
- cc_type: string;
- last_digits: string;
+ brand: string;
+ last4: string;
month: number;
year: number;
name: string | null;
diff --git a/packages/sdk/src/types/generated/CartPromotion.ts b/packages/admin-sdk/src/types/generated/Discount.ts
similarity index 67%
rename from packages/sdk/src/types/generated/CartPromotion.ts
rename to packages/admin-sdk/src/types/generated/Discount.ts
index 983ef8b358..c03238cf90 100644
--- a/packages/sdk/src/types/generated/CartPromotion.ts
+++ b/packages/admin-sdk/src/types/generated/Discount.ts
@@ -1,8 +1,8 @@
-// Typelizer digest 54401dcd6412f0dc49765976206fe66f
+// Typelizer digest 722e5b14b91abb060eb4ecdbc858e112
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-interface CartPromotion {
+interface Discount {
id: string;
promotion_id: string;
name: string;
@@ -12,4 +12,4 @@ interface CartPromotion {
display_amount: string;
}
-export default CartPromotion;
+export default Discount;
diff --git a/packages/admin-sdk/src/types/generated/LineItem.ts b/packages/admin-sdk/src/types/generated/LineItem.ts
index 6e51242cbc..e630a420c0 100644
--- a/packages/admin-sdk/src/types/generated/LineItem.ts
+++ b/packages/admin-sdk/src/types/generated/LineItem.ts
@@ -1,4 +1,4 @@
-// Typelizer digest be372dcb3fbf9e8c1715b5fa6b9f0f8b
+// Typelizer digest 8751efbed05eb944d2155294aeaf8b28
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {OptionValue, DigitalLink, Order, Variant, TaxCategory, Adjustment} from '@/types'
@@ -21,8 +21,8 @@ interface LineItem {
display_additional_tax_total: string;
included_tax_total: string;
display_included_tax_total: string;
- promo_total: string;
- display_promo_total: string;
+ discount_total: string;
+ display_discount_total: string;
pre_tax_amount: string;
display_pre_tax_amount: string;
discounted_amount: string;
diff --git a/packages/admin-sdk/src/types/generated/OptionType.ts b/packages/admin-sdk/src/types/generated/OptionType.ts
index 53aced667e..90c2b668d9 100644
--- a/packages/admin-sdk/src/types/generated/OptionType.ts
+++ b/packages/admin-sdk/src/types/generated/OptionType.ts
@@ -1,4 +1,4 @@
-// Typelizer digest ec1637c3f0ac20310be7e9fa939d1c13
+// Typelizer digest d11b90b320a0cfd070f04beb1fc459c9
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {OptionValue} from '@/types'
@@ -6,7 +6,7 @@ import type {OptionValue} from '@/types'
interface OptionType {
id: string;
name: string;
- presentation: string;
+ label: string;
position: number;
option_values?: Array<OptionValue>;
}
diff --git a/packages/admin-sdk/src/types/generated/OptionValue.ts b/packages/admin-sdk/src/types/generated/OptionValue.ts
index 58babf846a..b9cb980d6c 100644
--- a/packages/admin-sdk/src/types/generated/OptionValue.ts
+++ b/packages/admin-sdk/src/types/generated/OptionValue.ts
@@ -1,4 +1,4 @@
-// Typelizer digest ee3a439d7df17caa6c5d7a446599fe9b
+// Typelizer digest e9076f2df5f23f46ce7b4e04604bdc55
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {OptionType} from '@/types'
@@ -7,10 +7,10 @@ interface OptionValue {
id: string;
option_type_id: string;
name: string;
- presentation: string;
+ label: string;
position: number;
option_type_name: string;
- option_type_presentation: string;
+ option_type_label: string;
option_type?: OptionType;
}
diff --git a/packages/admin-sdk/src/types/generated/Order.ts b/packages/admin-sdk/src/types/generated/Order.ts
index bb9c25a617..78e75fc2be 100644
--- a/packages/admin-sdk/src/types/generated/Order.ts
+++ b/packages/admin-sdk/src/types/generated/Order.ts
@@ -1,22 +1,22 @@
-// Typelizer digest 549f6dc4fd2e3f7cd37bd8d3286557d5
+// Typelizer digest e9f22c33153041c7b0cac12f9090b045
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {OrderPromotion, LineItem, Fulfillment, Payment, Address, PaymentMethod, Customer, Adjustment, ReturnAuthorization, Reimbursement} from '@/types'
+import type {Discount, LineItem, Fulfillment, Payment, Address, PaymentMethod, Customer, Adjustment, ReturnAuthorization, Reimbursement} from '@/types'
interface Order {
id: string;
number: string;
email: string;
- special_instructions: string | null;
+ customer_note: string | null;
currency: string;
locale: string | null;
- item_count: number;
+ total_quantity: number;
item_total: string;
display_item_total: string;
adjustment_total: string;
display_adjustment_total: string;
- promo_total: string;
- display_promo_total: string;
+ discount_total: string;
+ display_discount_total: string;
tax_total: string;
display_tax_total: string;
included_tax_total: string;
@@ -25,19 +25,19 @@ interface Order {
display_additional_tax_total: string;
total: string;
display_total: string;
+ delivery_total: string;
+ display_delivery_total: string;
+ fulfillment_status: string | null;
+ payment_status: string | null;
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>;
+ discounts?: Array<Discount>;
items?: Array<LineItem>;
fulfillments?: Array<Fulfillment>;
payments?: Array<Payment>;
- bill_address?: Address | null;
- ship_address?: Address | null;
+ billing_address?: Address | null;
+ shipping_address?: Address | null;
channel: string | null;
last_ip_address: string | null;
considered_risky: boolean;
diff --git a/packages/admin-sdk/src/types/generated/ReturnAuthorization.ts b/packages/admin-sdk/src/types/generated/ReturnAuthorization.ts
index d78801e655..4f54fcab7d 100644
--- a/packages/admin-sdk/src/types/generated/ReturnAuthorization.ts
+++ b/packages/admin-sdk/src/types/generated/ReturnAuthorization.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 9e981ef539316a7e4168000bb6552d14
+// Typelizer digest d170b4fef9b4ec56f59b39a9c5bc6e38
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Order, StockLocation} from '@/types'
@@ -8,7 +8,7 @@ interface ReturnAuthorization {
number: string;
created_at: string;
updated_at: string;
- state: string;
+ status: string;
order_id: string | null;
stock_location_id: string | null;
return_authorization_reason_id: string | null;
diff --git a/packages/admin-sdk/src/types/generated/index.ts b/packages/admin-sdk/src/types/generated/index.ts
index 5934b6ece7..db043e7f6d 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 35cd6c6042b48d94ad3e2ac043e468f8
+// Typelizer digest 1ec13db8677848368e2a73b2ae1a9f0e
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
export type { default as Address } from './Address'
@@ -12,13 +12,13 @@ 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 Discount } from './Discount'
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'
export type { default as OptionType } from './OptionType'
export type { default as OptionValue } from './OptionValue'
-export type { default as OrderPromotion } from './OrderPromotion'
export type { default as Order } from './Order'
export type { default as PaymentMethod } from './PaymentMethod'
export type { default as Payment } from './Payment'
diff --git a/packages/next/.changeset/rename-multi-search-to-search.md b/packages/next/.changeset/rename-multi-search-to-search.md
deleted file mode 100644
index 4dec467161..0000000000
--- a/packages/next/.changeset/rename-multi-search-to-search.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-"@spree/next": patch
----
-
-Updated to use `search` instead of `multi_search` parameter, matching the renamed Store API param. No breaking change — `multi_search` still works via backward compatibility.
diff --git a/packages/next/CHANGELOG.md b/packages/next/CHANGELOG.md
index d315658208..2688fc5823 100644
--- a/packages/next/CHANGELOG.md
+++ b/packages/next/CHANGELOG.md
@@ -1,5 +1,11 @@
# @spree/next
+## 0.14.0
+
+### Minor Changes
+
+- Update for Store API naming standardization. Re-exports `Discount` type (replaces `CartPromotion`/`OrderPromotion`). All address, cart, and order types now use standardized field names. Requires `@spree/sdk >= 0.14.0`.
+
## 0.13.1
### Patch Changes
diff --git a/packages/next/package.json b/packages/next/package.json
index d7c43c7c86..2bb5105720 100644
--- a/packages/next/package.json
+++ b/packages/next/package.json
@@ -1,6 +1,6 @@
{
"name": "@spree/next",
- "version": "0.13.1",
+ "version": "0.14.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.13.2",
+ "@spree/sdk": ">=0.14.0",
"next": ">=15.0.0",
"react": ">=19.0.0"
},
diff --git a/packages/next/src/index.ts b/packages/next/src/index.ts
index a7f39e519a..15adf3eb76 100644
--- a/packages/next/src/index.ts
+++ b/packages/next/src/index.ts
@@ -92,8 +92,7 @@ export type {
OptionType,
OptionValue,
Price,
- CartPromotion,
- OrderPromotion,
+ Discount,
PaginatedResponse,
AddressParams,
CreateCartParams,
diff --git a/packages/next/tests/actions/addresses.test.ts b/packages/next/tests/actions/addresses.test.ts
index ab03aecae5..5272e63f0f 100644
--- a/packages/next/tests/actions/addresses.test.ts
+++ b/packages/next/tests/actions/addresses.test.ts
@@ -54,7 +54,7 @@ describe('address actions', () => {
describe('listAddresses', () => {
it('returns addresses list', async () => {
- const mockAddresses = { data: [{ id: '1', firstname: 'John' }] };
+ const mockAddresses = { data: [{ id: '1', first_name: 'John' }] };
mockClient.customer.addresses.list.mockResolvedValue(mockAddresses);
const result = await listAddresses();
@@ -68,7 +68,7 @@ describe('address actions', () => {
describe('getAddress', () => {
it('returns a single address', async () => {
- const mockAddress = { id: '1', firstname: 'John', lastname: 'Doe' };
+ const mockAddress = { id: '1', first_name: 'John', last_name: 'Doe' };
mockClient.customer.addresses.get.mockResolvedValue(mockAddress);
const result = await getAddress('1');
@@ -83,11 +83,11 @@ describe('address actions', () => {
describe('createAddress', () => {
it('creates address and revalidates', async () => {
const params = {
- firstname: 'Jane',
- lastname: 'Doe',
+ first_name: 'Jane',
+ last_name: 'Doe',
address1: '456 Oak Ave',
city: 'LA',
- zipcode: '90001',
+ postal_code: '90001',
country_iso: 'US',
};
const mockAddress = { id: '2', ...params };
@@ -105,8 +105,8 @@ describe('address actions', () => {
describe('updateAddress', () => {
it('updates address and revalidates', async () => {
- const params = { firstname: 'Updated' };
- const mockAddress = { id: '1', firstname: 'Updated', lastname: 'Doe' };
+ const params = { first_name: 'Updated' };
+ const mockAddress = { id: '1', first_name: 'Updated', last_name: 'Doe' };
mockClient.customer.addresses.update.mockResolvedValue(mockAddress);
const result = await updateAddress('1', params);
diff --git a/packages/next/tests/actions/cart.test.ts b/packages/next/tests/actions/cart.test.ts
index 561d6caae6..a25aacada3 100644
--- a/packages/next/tests/actions/cart.test.ts
+++ b/packages/next/tests/actions/cart.test.ts
@@ -150,7 +150,7 @@ describe('cart actions', () => {
describe('updateItem', () => {
it('updates item and invalidates cache', async () => {
- const updatedCart = { id: 'cart_1', token: 'cart_token', item_count: 3 };
+ const updatedCart = { id: 'cart_1', token: 'cart_token', total_quantity: 3 };
mockCookies({
'_spree_cart_token': 'cart_token',
'_spree_cart_token_id': 'cart_1',
@@ -171,7 +171,7 @@ describe('cart actions', () => {
describe('removeItem', () => {
it('removes item and invalidates cache', async () => {
- const updatedCart = { id: 'cart_1', token: 'cart_token', item_count: 0 };
+ const updatedCart = { id: 'cart_1', token: 'cart_token', total_quantity: 0 };
mockCookies({
'_spree_cart_token': 'cart_token',
'_spree_cart_token_id': 'cart_1',
@@ -296,7 +296,7 @@ describe('cart actions', () => {
describe('applyCoupon', () => {
it('applies coupon and revalidates checkout and cart', async () => {
- const updatedCart = { id: 'cart_1', promo_total: -10 };
+ const updatedCart = { id: 'cart_1', discount_total: -10 };
mockCookies({
'_spree_cart_token': 'order_token',
'_spree_cart_token_id': 'cart_1',
@@ -318,7 +318,7 @@ describe('cart actions', () => {
describe('removeCoupon', () => {
it('removes coupon and revalidates checkout and cart', async () => {
- const updatedCart = { id: 'cart_1', promo_total: 0 };
+ const updatedCart = { id: 'cart_1', discount_total: 0 };
mockCookies({
'_spree_cart_token': 'order_token',
'_spree_cart_token_id': 'cart_1',
diff --git a/packages/next/tests/actions/credit-cards.test.ts b/packages/next/tests/actions/credit-cards.test.ts
index 65deec2208..9c99fe6b28 100644
--- a/packages/next/tests/actions/credit-cards.test.ts
+++ b/packages/next/tests/actions/credit-cards.test.ts
@@ -44,7 +44,7 @@ describe('credit card actions', () => {
describe('listCreditCards', () => {
it('returns credit cards list', async () => {
- const mockCards = { data: [{ id: '1', last_digits: '4242' }] };
+ const mockCards = { data: [{ id: '1', last4: '4242' }] };
mockClient.customer.creditCards.list.mockResolvedValue(mockCards);
const result = await listCreditCards();
diff --git a/packages/sdk-core/src/types.ts b/packages/sdk-core/src/types.ts
index f8948d8ed2..c8d46a8683 100644
--- a/packages/sdk-core/src/types.ts
+++ b/packages/sdk-core/src/types.ts
@@ -48,12 +48,12 @@ export interface ListParams {
// Address params
export interface AddressParams {
- firstname: string;
- lastname: string;
+ first_name: string;
+ last_name: string;
address1: string;
address2?: string;
city: string;
- zipcode: string;
+ postal_code: string;
phone?: string;
company?: string;
/** ISO 3166-1 alpha-2 country code (e.g., "US", "DE") */
@@ -62,6 +62,6 @@ export interface AddressParams {
state_abbr?: string;
/** State name - used for countries without predefined states */
state_name?: string;
- /** When true, relaxes validation requirements (name, phone, zipcode, street) */
+ /** When true, relaxes validation requirements (name, phone, postal_code, street) */
quick_checkout?: boolean;
}
diff --git a/packages/sdk/.changeset/rename-multi-search-to-search.md b/packages/sdk/.changeset/rename-multi-search-to-search.md
deleted file mode 100644
index f8d2ca8ad0..0000000000
--- a/packages/sdk/.changeset/rename-multi-search-to-search.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-"@spree/sdk": patch
----
-
-Rename `multi_search` to `search` in `ProductListParams` and `OrderListParams`. The `multi_search` param still works via backward compatibility on the backend but `search` is now the recommended parameter name for full-text search.
diff --git a/packages/sdk/CHANGELOG.md b/packages/sdk/CHANGELOG.md
index 1fcfabbdbf..d8dfe13389 100644
--- a/packages/sdk/CHANGELOG.md
+++ b/packages/sdk/CHANGELOG.md
@@ -1,5 +1,27 @@
# @spree/sdk
+## 0.14.0
+
+### Minor Changes
+
+- Standardize Store API naming against industry conventions (Shopify, Medusa, Saleor, Vendure).
+
+ **Breaking changes:**
+
+ - Address: `firstname` → `first_name`, `lastname` → `last_name`, `zipcode` → `postal_code`
+ - Cart/Order: `special_instructions` → `customer_note`, `item_count` → `total_quantity`, `promo_total` → `discount_total`, `bill_address` → `billing_address`, `ship_address` → `shipping_address`, `promotions` → `discounts`
+ - LineItem: `promo_total` → `discount_total`
+ - OptionType/OptionValue: `presentation` → `label`
+ - CreditCard: `cc_type` → `brand`, `last_digits` → `last4`, removed `gateway_payment_profile_id`
+ - ReturnAuthorization: `state` → `status`
+ - `CartPromotion`/`OrderPromotion` types replaced by unified `Discount` type
+ - `WishedItem` type replaced by `WishlistItem`
+ - `UpdateCartParams`: `ship_address` → `shipping_address`, `bill_address` → `billing_address`, `special_instructions` → `customer_note`
+ - `AddressParams`: `firstname` → `first_name`, `lastname` → `last_name`, `zipcode` → `postal_code`
+ - Promotion type slimmed to `id`, `name`, `description`, `code`
+ - Product filters: `presentation` → `label`
+ - Removed admin-only types from Store SDK (Asset, StockItem, StockMovement, StockTransfer, ShippingCategory, Reimbursement, Report, Export, Import, ImportRow, TaxCategory, CustomerReturn)
+
## 0.13.2
### Patch Changes
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
index d09ef75eff..089ccec265 100644
--- a/packages/sdk/package.json
+++ b/packages/sdk/package.json
@@ -1,6 +1,6 @@
{
"name": "@spree/sdk",
- "version": "0.13.2",
+ "version": "0.14.0",
"description": "Official TypeScript SDK for Spree Commerce Store API",
"type": "module",
"main": "./dist/index.cjs",
diff --git a/packages/sdk/scripts/generate-zod.ts b/packages/sdk/scripts/generate-zod.ts
index 7a4521b4c5..4b356939f9 100644
--- a/packages/sdk/scripts/generate-zod.ts
+++ b/packages/sdk/scripts/generate-zod.ts
@@ -16,12 +16,12 @@ interface ParsedType {
}
function parseTypeFile(content: string): ParsedType | null {
- const typeNameMatch = content.match(/^type\s+(\w+)\s*=\s*\{/m);
+ const typeNameMatch = content.match(/^(?:type\s+(\w+)\s*=\s*\{|interface\s+(\w+)\s*\{)/m);
if (!typeNameMatch) return null;
- const typeName = typeNameMatch[1];
+ const typeName = typeNameMatch[1] || typeNameMatch[2];
// Find the body between braces, handling nested braces (e.g., inline object types)
- const typeStart = content.indexOf('{', content.search(/^type\s+\w+\s*=\s*\{/m));
+ const typeStart = content.indexOf('{', content.search(/^(?:type\s+\w+\s*=\s*\{|interface\s+\w+\s*\{)/m));
if (typeStart === -1) return null;
let depth = 1;
let i = typeStart + 1;
diff --git a/packages/sdk/src/store-client.ts b/packages/sdk/src/store-client.ts
index 7a0972df0a..b11e2ba189 100644
--- a/packages/sdk/src/store-client.ts
+++ b/packages/sdk/src/store-client.ts
@@ -43,7 +43,7 @@ import type {
PaymentSetupSession,
Fulfillment,
Wishlist,
- WishedItem,
+ WishlistItem,
Address,
Customer,
} from './types';
@@ -997,8 +997,8 @@ export class StoreClient {
wishlistId: string,
params: { variant_id: string; quantity?: number },
options?: RequestOptions
- ): Promise<WishedItem> =>
- this.request<WishedItem>('POST', `/wishlists/${wishlistId}/items`, {
+ ): Promise<WishlistItem> =>
+ this.request<WishlistItem>('POST', `/wishlists/${wishlistId}/items`, {
...options,
body: params,
}),
@@ -1011,8 +1011,8 @@ export class StoreClient {
itemId: string,
params: { quantity: number },
options?: RequestOptions
- ): Promise<WishedItem> =>
- this.request<WishedItem>(
+ ): Promise<WishlistItem> =>
+ this.request<WishlistItem>(
'PATCH',
`/wishlists/${wishlistId}/items/${itemId}`,
{ ...options, body: params }
diff --git a/packages/sdk/src/types/generated/Address.ts b/packages/sdk/src/types/generated/Address.ts
index 7504ac6ba3..94e929f886 100644
--- a/packages/sdk/src/types/generated/Address.ts
+++ b/packages/sdk/src/types/generated/Address.ts
@@ -1,16 +1,16 @@
-// Typelizer digest 47ad95ee4e8271ca385ebfda2094f973
+// Typelizer digest e7435b4e8a4dd699bb9be468c5c164d5
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
interface Address {
id: string;
- firstname: string | null;
- lastname: string | null;
+ first_name: string | null;
+ last_name: string | null;
full_name: string;
address1: string | null;
address2: string | null;
+ postal_code: string | null;
city: string | null;
- zipcode: string | null;
phone: string | null;
company: string | null;
country_name: string;
diff --git a/packages/sdk/src/types/generated/Asset.ts b/packages/sdk/src/types/generated/Asset.ts
deleted file mode 100644
index 52635e89c7..0000000000
--- a/packages/sdk/src/types/generated/Asset.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-// Typelizer digest a023551d7c3344c9a60e7464f82839fa
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-
-interface Asset {
- id: string;
- viewable_id: string;
- type: string | null;
- viewable_type: string;
- position: number | null;
- alt: string | null;
- created_at: string;
- updated_at: string;
-}
-
-export default Asset;
diff --git a/packages/sdk/src/types/generated/Cart.ts b/packages/sdk/src/types/generated/Cart.ts
index 86c51aac82..327045010d 100644
--- a/packages/sdk/src/types/generated/Cart.ts
+++ b/packages/sdk/src/types/generated/Cart.ts
@@ -1,23 +1,23 @@
-// Typelizer digest 2b3fcada9fd207d7419f3c6d6460756c
+// Typelizer digest 24d402b5c85d770381d7ab29b6e46ee0
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {CartPromotion, LineItem, Fulfillment, Payment, Address, PaymentMethod} from '@/types'
+import type {Discount, LineItem, Fulfillment, Payment, Address, PaymentMethod} from '@/types'
interface Cart {
id: string;
number: string;
token: string;
email: string | null;
- special_instructions: string | null;
+ customer_note: string | null;
currency: string;
locale: string | null;
- item_count: number;
+ total_quantity: number;
item_total: string;
display_item_total: string;
adjustment_total: string;
display_adjustment_total: string;
- promo_total: string;
- display_promo_total: string;
+ discount_total: string;
+ display_discount_total: string;
tax_total: string;
display_tax_total: string;
included_tax_total: string;
@@ -26,19 +26,19 @@ interface Cart {
display_additional_tax_total: string;
total: string;
display_total: string;
- created_at: string;
- updated_at: string;
delivery_total: string;
display_delivery_total: string;
+ created_at: string;
+ updated_at: string;
current_step: string;
completed_steps: Array<string>;
requirements: Array<{step: string, field: string, message: string}>;
- promotions: Array<CartPromotion>;
+ discounts: Array<Discount>;
items: Array<LineItem>;
fulfillments: Array<Fulfillment>;
payments: Array<Payment>;
- bill_address: Address | null;
- ship_address: Address | null;
+ billing_address: Address | null;
+ shipping_address: Address | null;
payment_methods: Array<PaymentMethod>;
}
diff --git a/packages/sdk/src/types/generated/CreditCard.ts b/packages/sdk/src/types/generated/CreditCard.ts
index 2ac825ceb3..f01bcdbb08 100644
--- a/packages/sdk/src/types/generated/CreditCard.ts
+++ b/packages/sdk/src/types/generated/CreditCard.ts
@@ -1,16 +1,15 @@
-// Typelizer digest afc630b677e9e742f2f8a214811ba856
+// Typelizer digest 1165d27466e340ec6b6283cb891992f2
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
interface CreditCard {
id: string;
- cc_type: string;
- last_digits: string;
+ brand: string;
+ last4: string;
month: number;
year: number;
name: string | null;
default: boolean;
- gateway_payment_profile_id: string | null;
}
export default CreditCard;
diff --git a/packages/sdk/src/types/generated/CustomerReturn.ts b/packages/sdk/src/types/generated/CustomerReturn.ts
deleted file mode 100644
index 80863e2b16..0000000000
--- a/packages/sdk/src/types/generated/CustomerReturn.ts
+++ /dev/null
@@ -1,13 +0,0 @@
-// Typelizer digest 309d3df6743da6b1a297b36968f51da3
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-
-interface CustomerReturn {
- id: string;
- number: string;
- created_at: string;
- updated_at: string;
- stock_location_id: string | null;
-}
-
-export default CustomerReturn;
diff --git a/packages/admin-sdk/src/types/generated/OrderPromotion.ts b/packages/sdk/src/types/generated/Discount.ts
similarity index 67%
rename from packages/admin-sdk/src/types/generated/OrderPromotion.ts
rename to packages/sdk/src/types/generated/Discount.ts
index bf6560cf83..c03238cf90 100644
--- a/packages/admin-sdk/src/types/generated/OrderPromotion.ts
+++ b/packages/sdk/src/types/generated/Discount.ts
@@ -1,8 +1,8 @@
-// Typelizer digest 0e7858abf34307f0bb82715e25d68a4a
+// Typelizer digest 722e5b14b91abb060eb4ecdbc858e112
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-interface OrderPromotion {
+interface Discount {
id: string;
promotion_id: string;
name: string;
@@ -12,4 +12,4 @@ interface OrderPromotion {
display_amount: string;
}
-export default OrderPromotion;
+export default Discount;
diff --git a/packages/sdk/src/types/generated/Export.ts b/packages/sdk/src/types/generated/Export.ts
deleted file mode 100644
index 8402ce39da..0000000000
--- a/packages/sdk/src/types/generated/Export.ts
+++ /dev/null
@@ -1,15 +0,0 @@
-// Typelizer digest 8e0d01ae1f102959e555923db7d98633
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-
-interface Export {
- id: string;
- number: string;
- type: string | null;
- format: string | null;
- created_at: string;
- updated_at: string;
- user_id: string | null;
-}
-
-export default Export;
diff --git a/packages/sdk/src/types/generated/Import.ts b/packages/sdk/src/types/generated/Import.ts
deleted file mode 100644
index 6966fc6c0d..0000000000
--- a/packages/sdk/src/types/generated/Import.ts
+++ /dev/null
@@ -1,18 +0,0 @@
-// Typelizer digest 0f8f855ca98e40f04e929783fb3dc9b5
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-
-interface Import {
- id: string;
- number: string;
- type: string | null;
- rows_count: number;
- created_at: string;
- updated_at: string;
- status: string;
- owner_type: string | null;
- owner_id: string | null;
- user_id: string | null;
-}
-
-export default Import;
diff --git a/packages/sdk/src/types/generated/ImportRow.ts b/packages/sdk/src/types/generated/ImportRow.ts
deleted file mode 100644
index 1f04a5a4f3..0000000000
--- a/packages/sdk/src/types/generated/ImportRow.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-// Typelizer digest a2ee5549fe3006ceb53fc73cff490035
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-
-interface ImportRow {
- id: string;
- row_number: number;
- status: string;
- validation_errors: unknown;
- item_type: string | null;
- created_at: string;
- updated_at: string;
- import_id: string | null;
- item_id: string | null;
-}
-
-export default ImportRow;
diff --git a/packages/sdk/src/types/generated/LineItem.ts b/packages/sdk/src/types/generated/LineItem.ts
index cf1ff92474..13f720bfbd 100644
--- a/packages/sdk/src/types/generated/LineItem.ts
+++ b/packages/sdk/src/types/generated/LineItem.ts
@@ -1,4 +1,4 @@
-// Typelizer digest a4976dd4fb149a1dab7581b9888bfe7c
+// Typelizer digest bcbddf9615a3d997e01ba78cc5469a3d
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {OptionValue, DigitalLink} from '@/types'
@@ -21,8 +21,8 @@ interface LineItem {
display_additional_tax_total: string;
included_tax_total: string;
display_included_tax_total: string;
- promo_total: string;
- display_promo_total: string;
+ discount_total: string;
+ display_discount_total: string;
pre_tax_amount: string;
display_pre_tax_amount: string;
discounted_amount: string;
diff --git a/packages/sdk/src/types/generated/OptionType.ts b/packages/sdk/src/types/generated/OptionType.ts
index 358834a90b..0c3507bff4 100644
--- a/packages/sdk/src/types/generated/OptionType.ts
+++ b/packages/sdk/src/types/generated/OptionType.ts
@@ -1,11 +1,11 @@
-// Typelizer digest 2c7173632ece6815db74bcd86636782d
+// Typelizer digest d69a4794e4392d769eaf50c280554fda
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
interface OptionType {
id: string;
name: string;
- presentation: string;
+ label: string;
position: number;
}
diff --git a/packages/sdk/src/types/generated/OptionValue.ts b/packages/sdk/src/types/generated/OptionValue.ts
index dcc8603789..77c4c44a2e 100644
--- a/packages/sdk/src/types/generated/OptionValue.ts
+++ b/packages/sdk/src/types/generated/OptionValue.ts
@@ -1,4 +1,4 @@
-// Typelizer digest ad46da762e32da9f049a9198e8e3c7f8
+// Typelizer digest bb5b3c7aa6954dccb01a600d7507f434
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -6,10 +6,10 @@ interface OptionValue {
id: string;
option_type_id: string;
name: string;
- presentation: string;
+ label: string;
position: number;
option_type_name: string;
- option_type_presentation: string;
+ option_type_label: string;
}
export default OptionValue;
diff --git a/packages/sdk/src/types/generated/Order.ts b/packages/sdk/src/types/generated/Order.ts
index adcd38a7b9..4c15deebc7 100644
--- a/packages/sdk/src/types/generated/Order.ts
+++ b/packages/sdk/src/types/generated/Order.ts
@@ -1,22 +1,22 @@
-// Typelizer digest 39e430d8615139aab548aeb629896db8
+// Typelizer digest a46934883d428ccd5269d68536b8af5f
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {OrderPromotion, LineItem, Fulfillment, Payment, Address} from '@/types'
+import type {Discount, LineItem, Fulfillment, Payment, Address} from '@/types'
interface Order {
id: string;
number: string;
email: string;
- special_instructions: string | null;
+ customer_note: string | null;
currency: string;
locale: string | null;
- item_count: number;
+ total_quantity: number;
item_total: string;
display_item_total: string;
adjustment_total: string;
display_adjustment_total: string;
- promo_total: string;
- display_promo_total: string;
+ discount_total: string;
+ display_discount_total: string;
tax_total: string;
display_tax_total: string;
included_tax_total: string;
@@ -25,19 +25,19 @@ interface Order {
display_additional_tax_total: string;
total: string;
display_total: string;
+ delivery_total: string;
+ display_delivery_total: string;
+ fulfillment_status: string | null;
+ payment_status: string | null;
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>;
+ discounts: Array<Discount>;
items: Array<LineItem>;
fulfillments: Array<Fulfillment>;
payments: Array<Payment>;
- bill_address: Address | null;
- ship_address: Address | null;
+ billing_address: Address | null;
+ shipping_address: Address | null;
}
export default Order;
diff --git a/packages/sdk/src/types/generated/OrderPromotion.ts b/packages/sdk/src/types/generated/OrderPromotion.ts
deleted file mode 100644
index bf6560cf83..0000000000
--- a/packages/sdk/src/types/generated/OrderPromotion.ts
+++ /dev/null
@@ -1,15 +0,0 @@
-// Typelizer digest 0e7858abf34307f0bb82715e25d68a4a
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-
-interface OrderPromotion {
- id: string;
- promotion_id: string;
- name: string;
- description: string | null;
- code: string | null;
- amount: string;
- display_amount: string;
-}
-
-export default OrderPromotion;
diff --git a/packages/sdk/src/types/generated/PaymentSource.ts b/packages/sdk/src/types/generated/PaymentSource.ts
index eae88b72b0..d67dcaecc3 100644
--- a/packages/sdk/src/types/generated/PaymentSource.ts
+++ b/packages/sdk/src/types/generated/PaymentSource.ts
@@ -1,10 +1,9 @@
-// Typelizer digest a090566d1133c4c29bc1f262a7fd6604
+// Typelizer digest 4ddc730a54ae081763951ebf5e595ba3
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
interface PaymentSource {
id: string;
- gateway_payment_profile_id: string | null;
}
export default PaymentSource;
diff --git a/packages/sdk/src/types/generated/Promotion.ts b/packages/sdk/src/types/generated/Promotion.ts
index 78708dbd72..aa2bf6bd4a 100644
--- a/packages/sdk/src/types/generated/Promotion.ts
+++ b/packages/sdk/src/types/generated/Promotion.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 73d9d31363fe2d5340d30447a96cfe79
+// Typelizer digest d615553cde839c36a609d0c40630e7d9
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -7,20 +7,6 @@ interface Promotion {
name: string;
description: string | null;
code: string | null;
- type: string | null;
- kind: string | null;
- path: string | null;
- match_policy: string | null;
- usage_limit: number | null;
- advertise: boolean;
- multi_codes: boolean;
- code_prefix: string | null;
- number_of_codes: number | null;
- starts_at: string | null;
- expires_at: string | null;
- created_at: string;
- updated_at: string;
- promotion_category_id: string | null;
}
export default Promotion;
diff --git a/packages/sdk/src/types/generated/Reimbursement.ts b/packages/sdk/src/types/generated/Reimbursement.ts
deleted file mode 100644
index c8ece0567d..0000000000
--- a/packages/sdk/src/types/generated/Reimbursement.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-// Typelizer digest 2702b19023c9033db7bda14e38a7a700
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-
-interface Reimbursement {
- id: string;
- number: string;
- reimbursement_status: string | null;
- created_at: string;
- updated_at: string;
- total: string | null;
- order_id: string | null;
- customer_return_id: string | null;
-}
-
-export default Reimbursement;
diff --git a/packages/sdk/src/types/generated/Report.ts b/packages/sdk/src/types/generated/Report.ts
deleted file mode 100644
index 6ecf0fa9ce..0000000000
--- a/packages/sdk/src/types/generated/Report.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-// Typelizer digest dd6e907ae639bd0ab37cb10b46cc31bf
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-
-interface Report {
- id: string;
- type: string | null;
- currency: string | null;
- created_at: string;
- updated_at: string;
- user_id: string | null;
- date_from: string | null;
- date_to: string | null;
-}
-
-export default Report;
diff --git a/packages/sdk/src/types/generated/ReturnAuthorization.ts b/packages/sdk/src/types/generated/ReturnAuthorization.ts
index f2ef3a97aa..5189f75dd5 100644
--- a/packages/sdk/src/types/generated/ReturnAuthorization.ts
+++ b/packages/sdk/src/types/generated/ReturnAuthorization.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 6d6869999be7c0ca6b8572397fd85559
+// Typelizer digest 9b984aa982bdc1fe82efa2543ab16015
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -7,7 +7,7 @@ interface ReturnAuthorization {
number: string;
created_at: string;
updated_at: string;
- state: string;
+ status: string;
order_id: string | null;
stock_location_id: string | null;
return_authorization_reason_id: string | null;
diff --git a/packages/sdk/src/types/generated/ShippingCategory.ts b/packages/sdk/src/types/generated/ShippingCategory.ts
deleted file mode 100644
index d046ad5931..0000000000
--- a/packages/sdk/src/types/generated/ShippingCategory.ts
+++ /dev/null
@@ -1,10 +0,0 @@
-// Typelizer digest 4fd74c75c3a2572c65a81bc9149be815
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-
-interface ShippingCategory {
- id: string;
- name: string;
-}
-
-export default ShippingCategory;
diff --git a/packages/sdk/src/types/generated/StockItem.ts b/packages/sdk/src/types/generated/StockItem.ts
deleted file mode 100644
index 75abe79b76..0000000000
--- a/packages/sdk/src/types/generated/StockItem.ts
+++ /dev/null
@@ -1,15 +0,0 @@
-// Typelizer digest 62638d5cb47d5092275e90125feb8f48
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-
-interface StockItem {
- id: string;
- count_on_hand: number;
- backorderable: boolean;
- created_at: string;
- updated_at: string;
- stock_location_id: string | null;
- variant_id: string | null;
-}
-
-export default StockItem;
diff --git a/packages/sdk/src/types/generated/StockMovement.ts b/packages/sdk/src/types/generated/StockMovement.ts
deleted file mode 100644
index b8415db2d3..0000000000
--- a/packages/sdk/src/types/generated/StockMovement.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-// Typelizer digest 3ec060aa17258fe8fd861a75738860fc
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-
-interface StockMovement {
- id: string;
- quantity: number;
- action: string | null;
- originator_type: string | null;
- created_at: string;
- updated_at: string;
- originator_id: string | null;
- stock_item_id: string | null;
-}
-
-export default StockMovement;
diff --git a/packages/sdk/src/types/generated/StockTransfer.ts b/packages/sdk/src/types/generated/StockTransfer.ts
deleted file mode 100644
index 2b14db2280..0000000000
--- a/packages/sdk/src/types/generated/StockTransfer.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-// Typelizer digest bcdc85eb5c163a055cfc7b5f83b5a78a
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-
-interface StockTransfer {
- id: string;
- number: string | null;
- type: string | null;
- reference: string | null;
- created_at: string;
- updated_at: string;
- source_location_id: string | null;
- destination_location_id: string | null;
-}
-
-export default StockTransfer;
diff --git a/packages/sdk/src/types/generated/TaxCategory.ts b/packages/sdk/src/types/generated/TaxCategory.ts
deleted file mode 100644
index 0ec62cf2eb..0000000000
--- a/packages/sdk/src/types/generated/TaxCategory.ts
+++ /dev/null
@@ -1,10 +0,0 @@
-// Typelizer digest 4c57a5a54d9ce3118ca18b0527039d8d
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-
-interface TaxCategory {
- id: string;
- name: string;
-}
-
-export default TaxCategory;
diff --git a/packages/sdk/src/types/generated/Wishlist.ts b/packages/sdk/src/types/generated/Wishlist.ts
index 127d304b09..6927964ff5 100644
--- a/packages/sdk/src/types/generated/Wishlist.ts
+++ b/packages/sdk/src/types/generated/Wishlist.ts
@@ -1,7 +1,7 @@
-// Typelizer digest 6ea7917f69069f5117e61d4480692eb7
+// Typelizer digest 7dacbdb7ec1d7b6a108d5b79f69efc3d
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {WishedItem} from '@/types'
+import type {WishlistItem} from '@/types'
interface Wishlist {
id: string;
@@ -11,7 +11,7 @@ interface Wishlist {
updated_at: string;
is_default: boolean;
is_private: boolean;
- items?: Array<WishedItem>;
+ items?: Array<WishlistItem>;
}
export default Wishlist;
diff --git a/packages/sdk/src/types/generated/WishedItem.ts b/packages/sdk/src/types/generated/WishlistItem.ts
similarity index 70%
rename from packages/sdk/src/types/generated/WishedItem.ts
rename to packages/sdk/src/types/generated/WishlistItem.ts
index c2a13a9501..53071742af 100644
--- a/packages/sdk/src/types/generated/WishedItem.ts
+++ b/packages/sdk/src/types/generated/WishlistItem.ts
@@ -1,9 +1,9 @@
-// Typelizer digest f9f787980753b06a34d42e1f075e318f
+// Typelizer digest 271ed31f047c777e641dac59e6fbb064
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Variant} from '@/types'
-interface WishedItem {
+interface WishlistItem {
id: string;
variant_id: string;
wishlist_id: string;
@@ -13,4 +13,4 @@ interface WishedItem {
variant: Variant;
}
-export default WishedItem;
+export default WishlistItem;
diff --git a/packages/sdk/src/types/generated/index.ts b/packages/sdk/src/types/generated/index.ts
index db56531377..0e3bbf93b8 100644
--- a/packages/sdk/src/types/generated/index.ts
+++ b/packages/sdk/src/types/generated/index.ts
@@ -1,27 +1,22 @@
-// Typelizer digest 49cc65a997ae2b72cd4d5427d79d9cde
+// Typelizer digest 4eeaa53c3702be006b83c52a632fbcd3
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
export type { default as Address } from './Address'
-export type { default as Asset } from './Asset'
export type { default as Base } from './Base'
-export type { default as CartPromotion } from './CartPromotion'
export type { default as Cart } from './Cart'
export type { default as Category } from './Category'
export type { default as Country } from './Country'
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 Discount } from './Discount'
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'
-export type { default as Import } from './Import'
export type { default as Invitation } from './Invitation'
export type { default as LineItem } from './LineItem'
export type { default as Locale } from './Locale'
@@ -31,7 +26,6 @@ export type { default as Metafield } from './Metafield'
export type { default as NewsletterSubscriber } from './NewsletterSubscriber'
export type { default as OptionType } from './OptionType'
export type { default as OptionValue } from './OptionValue'
-export type { default as OrderPromotion } from './OrderPromotion'
export type { default as Order } from './Order'
export type { default as PaymentMethod } from './PaymentMethod'
export type { default as Payment } from './Payment'
@@ -42,18 +36,11 @@ export type { default as Price } from './Price'
export type { default as Product } from './Product'
export type { default as Promotion } from './Promotion'
export type { default as Refund } from './Refund'
-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 ShippingCategory } from './ShippingCategory'
export type { default as State } from './State'
-export type { default as StockItem } from './StockItem'
export type { default as StockLocation } from './StockLocation'
-export type { default as StockMovement } from './StockMovement'
-export type { default as StockTransfer } from './StockTransfer'
export type { default as StoreCredit } from './StoreCredit'
-export type { default as TaxCategory } from './TaxCategory'
export type { default as Variant } from './Variant'
-export type { default as WishedItem } from './WishedItem'
+export type { default as WishlistItem } from './WishlistItem'
export type { default as Wishlist } from './Wishlist'
diff --git a/packages/sdk/src/types/index.ts b/packages/sdk/src/types/index.ts
index 3043931ff8..59afc0e743 100644
--- a/packages/sdk/src/types/index.ts
+++ b/packages/sdk/src/types/index.ts
@@ -3,24 +3,19 @@ import type { ListParams, AddressParams } from '@spree/sdk-core';
// Re-export all generated types (unprefixed: Product, Order, etc.)
export type {
Address,
- Asset,
Base,
Cart,
- CartPromotion,
Category,
Country,
CreditCard,
Currency,
- CustomerReturn,
Customer,
DigitalLink,
Digital,
- Export,
+ Discount,
GiftCardBatch,
GiftCard,
Media,
- ImportRow,
- Import,
Invitation,
LineItem,
Locale,
@@ -29,7 +24,6 @@ export type {
NewsletterSubscriber,
OptionType,
OptionValue,
- OrderPromotion,
Order,
PaymentMethod,
Payment,
@@ -40,36 +34,28 @@ export type {
Product,
Promotion,
Refund,
- Reimbursement,
- Report,
ReturnAuthorization,
ReturnItem,
DeliveryMethod,
DeliveryRate,
Fulfillment,
- ShippingCategory,
State,
- StockItem,
StockLocation,
- StockMovement,
- StockTransfer,
StoreCredit,
- TaxCategory,
Variant,
- WishedItem,
+ WishlistItem,
Wishlist,
} from './generated';
// Backward compatibility aliases (Store* prefix)
export type { Address as StoreAddress } from './generated';
-export type { Asset as StoreAsset } from './generated';
export type { Cart as StoreCart } from './generated';
export type { Category as StoreCategory } from './generated';
export type { Country as StoreCountry } from './generated';
export type { CreditCard as StoreCreditCard } from './generated';
export type { Currency as StoreCurrency } from './generated';
-export type { CustomerReturn as StoreCustomerReturn } from './generated';
export type { Customer as StoreCustomer } from './generated';
+export type { Discount as StoreDiscount } from './generated';
export type { DigitalLink as StoreDigitalLink } from './generated';
export type { Digital as StoreDigital } from './generated';
export type { GiftCardBatch as StoreGiftCardBatch } from './generated';
@@ -81,8 +67,6 @@ export type { Market as StoreMarket } from './generated';
export type { Metafield as StoreMetafield } from './generated';
export type { OptionType as StoreOptionType } from './generated';
export type { OptionValue as StoreOptionValue } from './generated';
-export type { CartPromotion as StoreCartPromotion } from './generated';
-export type { OrderPromotion as StoreOrderPromotion } from './generated';
export type { Order as StoreOrder } from './generated';
export type { PaymentMethod as StorePaymentMethod } from './generated';
export type { Payment as StorePayment } from './generated';
@@ -93,27 +77,23 @@ export type { Price as StorePrice } from './generated';
export type { Product as StoreProduct } from './generated';
export type { Promotion as StorePromotion } from './generated';
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 { 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 { State as StoreState } from './generated';
-export type { StockItem as StoreStockItem } from './generated';
export type { StockLocation as StoreStockLocation } from './generated';
export type { StoreCredit as StoreStoreCredit } from './generated';
-export type { TaxCategory as StoreTaxCategory } from './generated';
export type { Variant as StoreVariant } from './generated';
-export type { WishedItem as StoreWishedItem } from './generated';
+export type { WishlistItem as StoreWishlistItem } from './generated';
export type { Wishlist as StoreWishlist } from './generated';
// Checkout requirement — a single unsatisfied checkout prerequisite
export interface CheckoutRequirement {
/** Checkout step this requirement belongs to (e.g. "address", "payment") */
step: string;
- /** Field that needs to be satisfied (e.g. "email", "ship_address") */
+ /** Field that needs to be satisfied (e.g. "email", "shipping_address") */
field: string;
/** Human-readable message describing what's needed */
message: string;
@@ -250,17 +230,17 @@ export interface UpdateCartParams {
email?: string;
currency?: string;
locale?: string;
- special_instructions?: string;
+ customer_note?: string;
/** Arbitrary key-value metadata (merged with existing) */
metadata?: Record<string, unknown>;
- /** Existing address ID to use */
- bill_address_id?: string;
- /** Existing address ID to use */
- ship_address_id?: string;
+ /** Existing address ID to use as billing address */
+ billing_address_id?: string;
+ /** Existing address ID to use as shipping address */
+ shipping_address_id?: string;
/** New billing address */
- bill_address?: AddressParams;
+ billing_address?: AddressParams;
/** New shipping address */
- ship_address?: AddressParams;
+ shipping_address?: AddressParams;
/** Items to upsert (sets quantity for existing, creates new) */
items?: LineItemInput[];
}
@@ -307,7 +287,7 @@ export interface FilterOption {
export interface OptionFilterOption extends FilterOption {
name: string;
- presentation: string;
+ label: string;
position: number;
}
@@ -336,7 +316,7 @@ export interface OptionFilter {
id: string;
type: 'option';
name: string;
- presentation: string;
+ label: string;
options: OptionFilterOption[];
}
diff --git a/packages/sdk/src/zod/generated/Address.ts b/packages/sdk/src/zod/generated/Address.ts
index c22bf947ad..04fef74658 100644
--- a/packages/sdk/src/zod/generated/Address.ts
+++ b/packages/sdk/src/zod/generated/Address.ts
@@ -3,13 +3,13 @@ import { z } from 'zod';
export const AddressSchema = z.object({
id: z.string(),
- firstname: z.string().nullable(),
- lastname: z.string().nullable(),
+ first_name: z.string().nullable(),
+ last_name: z.string().nullable(),
full_name: z.string(),
address1: z.string().nullable(),
address2: z.string().nullable(),
+ postal_code: z.string().nullable(),
city: z.string().nullable(),
- zipcode: z.string().nullable(),
phone: z.string().nullable(),
company: z.string().nullable(),
country_name: z.string(),
diff --git a/packages/sdk/src/zod/generated/Asset.ts b/packages/sdk/src/zod/generated/Asset.ts
deleted file mode 100644
index 78fe94450b..0000000000
--- a/packages/sdk/src/zod/generated/Asset.ts
+++ /dev/null
@@ -1,15 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-
-export const AssetSchema = z.object({
- id: z.string(),
- viewable_id: z.string(),
- type: z.string().nullable(),
- viewable_type: z.string(),
- position: z.number().nullable(),
- alt: z.string().nullable(),
- created_at: z.string(),
- updated_at: z.string(),
-});
-
-export type Asset = z.infer<typeof AssetSchema>;
diff --git a/packages/sdk/src/zod/generated/Cart.ts b/packages/sdk/src/zod/generated/Cart.ts
index 9b7a387cd5..63cedda7ef 100644
--- a/packages/sdk/src/zod/generated/Cart.ts
+++ b/packages/sdk/src/zod/generated/Cart.ts
@@ -1,7 +1,7 @@
// This file is auto-generated. Do not edit directly.
import { z } from 'zod';
import { AddressSchema } from './Address';
-import { CartPromotionSchema } from './CartPromotion';
+import { DiscountSchema } from './Discount';
import { FulfillmentSchema } from './Fulfillment';
import { LineItemSchema } from './LineItem';
import { PaymentSchema } from './Payment';
@@ -12,16 +12,16 @@ export const CartSchema = z.object({
number: z.string(),
token: z.string(),
email: z.string().nullable(),
- special_instructions: z.string().nullable(),
+ customer_note: z.string().nullable(),
currency: z.string(),
locale: z.string().nullable(),
- item_count: z.number(),
+ total_quantity: z.number(),
item_total: z.string(),
display_item_total: z.string(),
adjustment_total: z.string(),
display_adjustment_total: z.string(),
- promo_total: z.string(),
- display_promo_total: z.string(),
+ discount_total: z.string(),
+ display_discount_total: z.string(),
tax_total: z.string(),
display_tax_total: z.string(),
included_tax_total: z.string(),
@@ -30,19 +30,19 @@ export const CartSchema = z.object({
display_additional_tax_total: z.string(),
total: z.string(),
display_total: z.string(),
- created_at: z.string(),
- updated_at: z.string(),
delivery_total: z.string(),
display_delivery_total: z.string(),
+ created_at: z.string(),
+ updated_at: 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),
+ discounts: z.array(DiscountSchema),
items: z.array(LineItemSchema),
fulfillments: z.array(FulfillmentSchema),
payments: z.array(PaymentSchema),
- bill_address: AddressSchema.nullable(),
- ship_address: AddressSchema.nullable(),
+ billing_address: AddressSchema.nullable(),
+ shipping_address: AddressSchema.nullable(),
payment_methods: z.array(PaymentMethodSchema),
});
diff --git a/packages/sdk/src/zod/generated/CreditCard.ts b/packages/sdk/src/zod/generated/CreditCard.ts
index 5c533cea09..1c0c071f6b 100644
--- a/packages/sdk/src/zod/generated/CreditCard.ts
+++ b/packages/sdk/src/zod/generated/CreditCard.ts
@@ -3,13 +3,12 @@ import { z } from 'zod';
export const CreditCardSchema = z.object({
id: z.string(),
- cc_type: z.string(),
- last_digits: z.string(),
+ brand: z.string(),
+ last4: z.string(),
month: z.number(),
year: z.number(),
name: z.string().nullable(),
default: z.boolean(),
- gateway_payment_profile_id: z.string().nullable(),
});
export type CreditCard = z.infer<typeof CreditCardSchema>;
diff --git a/packages/sdk/src/zod/generated/CustomerReturn.ts b/packages/sdk/src/zod/generated/CustomerReturn.ts
deleted file mode 100644
index 14424a3c82..0000000000
--- a/packages/sdk/src/zod/generated/CustomerReturn.ts
+++ /dev/null
@@ -1,12 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-
-export const CustomerReturnSchema = z.object({
- id: z.string(),
- number: z.string(),
- created_at: z.string(),
- updated_at: z.string(),
- stock_location_id: z.string().nullable(),
-});
-
-export type CustomerReturn = z.infer<typeof CustomerReturnSchema>;
diff --git a/packages/sdk/src/zod/generated/CartPromotion.ts b/packages/sdk/src/zod/generated/Discount.ts
similarity index 71%
rename from packages/sdk/src/zod/generated/CartPromotion.ts
rename to packages/sdk/src/zod/generated/Discount.ts
index f50dd4d51d..556d8c3213 100644
--- a/packages/sdk/src/zod/generated/CartPromotion.ts
+++ b/packages/sdk/src/zod/generated/Discount.ts
@@ -1,7 +1,7 @@
// This file is auto-generated. Do not edit directly.
import { z } from 'zod';
-export const CartPromotionSchema = z.object({
+export const DiscountSchema = z.object({
id: z.string(),
promotion_id: z.string(),
name: z.string(),
@@ -11,4 +11,4 @@ export const CartPromotionSchema = z.object({
display_amount: z.string(),
});
-export type CartPromotion = z.infer<typeof CartPromotionSchema>;
+export type Discount = z.infer<typeof DiscountSchema>;
diff --git a/packages/sdk/src/zod/generated/Export.ts b/packages/sdk/src/zod/generated/Export.ts
deleted file mode 100644
index 32af9e5158..0000000000
--- a/packages/sdk/src/zod/generated/Export.ts
+++ /dev/null
@@ -1,14 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-
-export const ExportSchema = z.object({
- id: z.string(),
- number: z.string(),
- type: z.string().nullable(),
- format: z.string().nullable(),
- created_at: z.string(),
- updated_at: z.string(),
- user_id: z.string().nullable(),
-});
-
-export type Export = z.infer<typeof ExportSchema>;
diff --git a/packages/sdk/src/zod/generated/Import.ts b/packages/sdk/src/zod/generated/Import.ts
deleted file mode 100644
index 759717473b..0000000000
--- a/packages/sdk/src/zod/generated/Import.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-
-export const ImportSchema = z.object({
- id: z.string(),
- number: z.string(),
- type: z.string().nullable(),
- rows_count: z.number(),
- created_at: z.string(),
- updated_at: z.string(),
- status: z.string(),
- owner_type: z.string().nullable(),
- owner_id: z.string().nullable(),
- user_id: z.string().nullable(),
-});
-
-export type Import = z.infer<typeof ImportSchema>;
diff --git a/packages/sdk/src/zod/generated/ImportRow.ts b/packages/sdk/src/zod/generated/ImportRow.ts
deleted file mode 100644
index 6dbca9b66c..0000000000
--- a/packages/sdk/src/zod/generated/ImportRow.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-
-export const ImportRowSchema = z.object({
- id: z.string(),
- row_number: z.number(),
- status: z.string(),
- validation_errors: z.any(),
- item_type: z.string().nullable(),
- created_at: z.string(),
- updated_at: z.string(),
- import_id: z.string().nullable(),
- item_id: z.string().nullable(),
-});
-
-export type ImportRow = z.infer<typeof ImportRowSchema>;
diff --git a/packages/sdk/src/zod/generated/LineItem.ts b/packages/sdk/src/zod/generated/LineItem.ts
index 4549a3a2d8..d58835954e 100644
--- a/packages/sdk/src/zod/generated/LineItem.ts
+++ b/packages/sdk/src/zod/generated/LineItem.ts
@@ -21,8 +21,8 @@ export const LineItemSchema = z.object({
display_additional_tax_total: z.string(),
included_tax_total: z.string(),
display_included_tax_total: z.string(),
- promo_total: z.string(),
- display_promo_total: z.string(),
+ discount_total: z.string(),
+ display_discount_total: z.string(),
pre_tax_amount: z.string(),
display_pre_tax_amount: z.string(),
discounted_amount: z.string(),
diff --git a/packages/sdk/src/zod/generated/OptionType.ts b/packages/sdk/src/zod/generated/OptionType.ts
index fa922f08ab..34bfddde99 100644
--- a/packages/sdk/src/zod/generated/OptionType.ts
+++ b/packages/sdk/src/zod/generated/OptionType.ts
@@ -4,7 +4,7 @@ import { z } from 'zod';
export const OptionTypeSchema = z.object({
id: z.string(),
name: z.string(),
- presentation: z.string(),
+ label: z.string(),
position: z.number(),
});
diff --git a/packages/sdk/src/zod/generated/OptionValue.ts b/packages/sdk/src/zod/generated/OptionValue.ts
index 92efe0d246..ff510d6e9d 100644
--- a/packages/sdk/src/zod/generated/OptionValue.ts
+++ b/packages/sdk/src/zod/generated/OptionValue.ts
@@ -5,10 +5,10 @@ export const OptionValueSchema = z.object({
id: z.string(),
option_type_id: z.string(),
name: z.string(),
- presentation: z.string(),
+ label: z.string(),
position: z.number(),
option_type_name: z.string(),
- option_type_presentation: z.string(),
+ option_type_label: z.string(),
});
export type OptionValue = z.infer<typeof OptionValueSchema>;
diff --git a/packages/sdk/src/zod/generated/Order.ts b/packages/sdk/src/zod/generated/Order.ts
index 4a33a95cba..0bf55f4620 100644
--- a/packages/sdk/src/zod/generated/Order.ts
+++ b/packages/sdk/src/zod/generated/Order.ts
@@ -1,25 +1,25 @@
// This file is auto-generated. Do not edit directly.
import { z } from 'zod';
import { AddressSchema } from './Address';
+import { DiscountSchema } from './Discount';
import { FulfillmentSchema } from './Fulfillment';
import { LineItemSchema } from './LineItem';
-import { OrderPromotionSchema } from './OrderPromotion';
import { PaymentSchema } from './Payment';
export const OrderSchema = z.object({
id: z.string(),
number: z.string(),
email: z.string(),
- special_instructions: z.string().nullable(),
+ customer_note: z.string().nullable(),
currency: z.string(),
locale: z.string().nullable(),
- item_count: z.number(),
+ total_quantity: z.number(),
item_total: z.string(),
display_item_total: z.string(),
adjustment_total: z.string(),
display_adjustment_total: z.string(),
- promo_total: z.string(),
- display_promo_total: z.string(),
+ discount_total: z.string(),
+ display_discount_total: z.string(),
tax_total: z.string(),
display_tax_total: z.string(),
included_tax_total: z.string(),
@@ -28,19 +28,19 @@ export const OrderSchema = z.object({
display_additional_tax_total: z.string(),
total: z.string(),
display_total: z.string(),
+ delivery_total: z.string(),
+ display_delivery_total: z.string(),
+ fulfillment_status: z.string().nullable(),
+ payment_status: z.string().nullable(),
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),
+ discounts: z.array(DiscountSchema),
items: z.array(LineItemSchema),
fulfillments: z.array(FulfillmentSchema),
payments: z.array(PaymentSchema),
- bill_address: AddressSchema.nullable(),
- ship_address: AddressSchema.nullable(),
+ billing_address: AddressSchema.nullable(),
+ shipping_address: AddressSchema.nullable(),
});
export type Order = z.infer<typeof OrderSchema>;
diff --git a/packages/sdk/src/zod/generated/OrderPromotion.ts b/packages/sdk/src/zod/generated/OrderPromotion.ts
deleted file mode 100644
index c3858b71c7..0000000000
--- a/packages/sdk/src/zod/generated/OrderPromotion.ts
+++ /dev/null
@@ -1,14 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-
-export const OrderPromotionSchema = z.object({
- id: z.string(),
- promotion_id: z.string(),
- name: z.string(),
- description: z.string().nullable(),
- code: z.string().nullable(),
- amount: z.string(),
- display_amount: z.string(),
-});
-
-export type OrderPromotion = z.infer<typeof OrderPromotionSchema>;
diff --git a/packages/sdk/src/zod/generated/PaymentSource.ts b/packages/sdk/src/zod/generated/PaymentSource.ts
index 193fa1b116..1e95ed66b6 100644
--- a/packages/sdk/src/zod/generated/PaymentSource.ts
+++ b/packages/sdk/src/zod/generated/PaymentSource.ts
@@ -3,7 +3,6 @@ import { z } from 'zod';
export const PaymentSourceSchema = z.object({
id: z.string(),
- gateway_payment_profile_id: z.string().nullable(),
});
export type PaymentSource = z.infer<typeof PaymentSourceSchema>;
diff --git a/packages/sdk/src/zod/generated/Promotion.ts b/packages/sdk/src/zod/generated/Promotion.ts
index 54f7db4d5e..022d2a14a7 100644
--- a/packages/sdk/src/zod/generated/Promotion.ts
+++ b/packages/sdk/src/zod/generated/Promotion.ts
@@ -6,20 +6,6 @@ export const PromotionSchema = z.object({
name: z.string(),
description: z.string().nullable(),
code: z.string().nullable(),
- type: z.string().nullable(),
- kind: z.string().nullable(),
- path: z.string().nullable(),
- match_policy: z.string().nullable(),
- usage_limit: z.number().nullable(),
- advertise: z.boolean(),
- multi_codes: z.boolean(),
- code_prefix: z.string().nullable(),
- number_of_codes: z.number().nullable(),
- starts_at: z.string().nullable(),
- expires_at: z.string().nullable(),
- created_at: z.string(),
- updated_at: z.string(),
- promotion_category_id: z.string().nullable(),
});
export type Promotion = z.infer<typeof PromotionSchema>;
diff --git a/packages/sdk/src/zod/generated/Reimbursement.ts b/packages/sdk/src/zod/generated/Reimbursement.ts
deleted file mode 100644
index 559795f5aa..0000000000
--- a/packages/sdk/src/zod/generated/Reimbursement.ts
+++ /dev/null
@@ -1,15 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-
-export const ReimbursementSchema = z.object({
- id: z.string(),
- number: z.string(),
- reimbursement_status: z.string().nullable(),
- created_at: z.string(),
- updated_at: z.string(),
- total: z.string().nullable(),
- order_id: z.string().nullable(),
- customer_return_id: z.string().nullable(),
-});
-
-export type Reimbursement = z.infer<typeof ReimbursementSchema>;
diff --git a/packages/sdk/src/zod/generated/Report.ts b/packages/sdk/src/zod/generated/Report.ts
deleted file mode 100644
index 294f628958..0000000000
--- a/packages/sdk/src/zod/generated/Report.ts
+++ /dev/null
@@ -1,15 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-
-export const ReportSchema = z.object({
- id: z.string(),
- type: z.string().nullable(),
- currency: z.string().nullable(),
- created_at: z.string(),
- updated_at: z.string(),
- user_id: z.string().nullable(),
- date_from: z.string().nullable(),
- date_to: z.string().nullable(),
-});
-
-export type Report = z.infer<typeof ReportSchema>;
diff --git a/packages/sdk/src/zod/generated/ReturnAuthorization.ts b/packages/sdk/src/zod/generated/ReturnAuthorization.ts
index 13aea5fdfd..abbaa6fe87 100644
--- a/packages/sdk/src/zod/generated/ReturnAuthorization.ts
+++ b/packages/sdk/src/zod/generated/ReturnAuthorization.ts
@@ -6,7 +6,7 @@ export const ReturnAuthorizationSchema = z.object({
number: z.string(),
created_at: z.string(),
updated_at: z.string(),
- state: z.string(),
+ status: z.string(),
order_id: z.string().nullable(),
stock_location_id: z.string().nullable(),
return_authorization_reason_id: z.string().nullable(),
diff --git a/packages/sdk/src/zod/generated/ShippingCategory.ts b/packages/sdk/src/zod/generated/ShippingCategory.ts
deleted file mode 100644
index 3efafeca40..0000000000
--- a/packages/sdk/src/zod/generated/ShippingCategory.ts
+++ /dev/null
@@ -1,9 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-
-export const ShippingCategorySchema = z.object({
- id: z.string(),
- name: z.string(),
-});
-
-export type ShippingCategory = z.infer<typeof ShippingCategorySchema>;
diff --git a/packages/sdk/src/zod/generated/StockItem.ts b/packages/sdk/src/zod/generated/StockItem.ts
deleted file mode 100644
index ea6b4d7c7a..0000000000
--- a/packages/sdk/src/zod/generated/StockItem.ts
+++ /dev/null
@@ -1,14 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-
-export const StockItemSchema = z.object({
- id: z.string(),
- count_on_hand: z.number(),
- backorderable: z.boolean(),
- created_at: z.string(),
- updated_at: z.string(),
- stock_location_id: z.string().nullable(),
- variant_id: z.string().nullable(),
-});
-
-export type StockItem = z.infer<typeof StockItemSchema>;
diff --git a/packages/sdk/src/zod/generated/StockMovement.ts b/packages/sdk/src/zod/generated/StockMovement.ts
deleted file mode 100644
index d54939d1bb..0000000000
--- a/packages/sdk/src/zod/generated/StockMovement.ts
+++ /dev/null
@@ -1,15 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-
-export const StockMovementSchema = z.object({
- id: z.string(),
- quantity: z.number(),
- action: z.string().nullable(),
- originator_type: z.string().nullable(),
- created_at: z.string(),
- updated_at: z.string(),
- originator_id: z.string().nullable(),
- stock_item_id: z.string().nullable(),
-});
-
-export type StockMovement = z.infer<typeof StockMovementSchema>;
diff --git a/packages/sdk/src/zod/generated/StockTransfer.ts b/packages/sdk/src/zod/generated/StockTransfer.ts
deleted file mode 100644
index e6472efe49..0000000000
--- a/packages/sdk/src/zod/generated/StockTransfer.ts
+++ /dev/null
@@ -1,15 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-
-export const StockTransferSchema = z.object({
- id: z.string(),
- number: z.string().nullable(),
- type: z.string().nullable(),
- reference: z.string().nullable(),
- created_at: z.string(),
- updated_at: z.string(),
- source_location_id: z.string().nullable(),
- destination_location_id: z.string().nullable(),
-});
-
-export type StockTransfer = z.infer<typeof StockTransferSchema>;
diff --git a/packages/sdk/src/zod/generated/TaxCategory.ts b/packages/sdk/src/zod/generated/TaxCategory.ts
deleted file mode 100644
index 915367af11..0000000000
--- a/packages/sdk/src/zod/generated/TaxCategory.ts
+++ /dev/null
@@ -1,9 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-
-export const TaxCategorySchema = z.object({
- id: z.string(),
- name: z.string(),
-});
-
-export type TaxCategory = z.infer<typeof TaxCategorySchema>;
diff --git a/packages/sdk/src/zod/generated/Wishlist.ts b/packages/sdk/src/zod/generated/Wishlist.ts
index 2e9ce56a63..9842cb1de7 100644
--- a/packages/sdk/src/zod/generated/Wishlist.ts
+++ b/packages/sdk/src/zod/generated/Wishlist.ts
@@ -1,6 +1,6 @@
// This file is auto-generated. Do not edit directly.
import { z } from 'zod';
-import { WishedItemSchema } from './WishedItem';
+import { WishlistItemSchema } from './WishlistItem';
export const WishlistSchema = z.object({
id: z.string(),
@@ -10,7 +10,7 @@ export const WishlistSchema = z.object({
updated_at: z.string(),
is_default: z.boolean(),
is_private: z.boolean(),
- items: z.array(WishedItemSchema).optional(),
+ items: z.array(WishlistItemSchema).optional(),
});
export type Wishlist = z.infer<typeof WishlistSchema>;
diff --git a/packages/sdk/src/zod/generated/WishedItem.ts b/packages/sdk/src/zod/generated/WishlistItem.ts
similarity index 73%
rename from packages/sdk/src/zod/generated/WishedItem.ts
rename to packages/sdk/src/zod/generated/WishlistItem.ts
index adcc3bde06..047455ca4e 100644
--- a/packages/sdk/src/zod/generated/WishedItem.ts
+++ b/packages/sdk/src/zod/generated/WishlistItem.ts
@@ -2,7 +2,7 @@
import { z } from 'zod';
import { VariantSchema } from './Variant';
-export const WishedItemSchema = z.object({
+export const WishlistItemSchema = z.object({
id: z.string(),
variant_id: z.string(),
wishlist_id: z.string(),
@@ -12,4 +12,4 @@ export const WishedItemSchema = z.object({
variant: VariantSchema,
});
-export type WishedItem = z.infer<typeof WishedItemSchema>;
+export type WishlistItem = z.infer<typeof WishlistItemSchema>;
diff --git a/packages/sdk/src/zod/generated/index.ts b/packages/sdk/src/zod/generated/index.ts
index f03ef21576..0978e0103f 100644
--- a/packages/sdk/src/zod/generated/index.ts
+++ b/packages/sdk/src/zod/generated/index.ts
@@ -1,25 +1,20 @@
// This file is auto-generated. Do not edit directly.
export { AddressSchema, type Address } from './Address';
-export { AssetSchema, type Asset } from './Asset';
export { BaseSchema, type Base } from './Base';
export { CartSchema, type Cart } from './Cart';
-export { CartPromotionSchema, type CartPromotion } from './CartPromotion';
export { CategorySchema, type Category } from './Category';
export { CountrySchema, type Country } from './Country';
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 { DiscountSchema, type Discount } from './Discount';
export { FulfillmentSchema, type Fulfillment } from './Fulfillment';
export { GiftCardSchema, type GiftCard } from './GiftCard';
export { GiftCardBatchSchema, type GiftCardBatch } from './GiftCardBatch';
-export { ImportSchema, type Import } from './Import';
-export { ImportRowSchema, type ImportRow } from './ImportRow';
export { InvitationSchema, type Invitation } from './Invitation';
export { LineItemSchema, type LineItem } from './LineItem';
export { LocaleSchema, type Locale } from './Locale';
@@ -30,7 +25,6 @@ export { NewsletterSubscriberSchema, type NewsletterSubscriber } from './Newslet
export { OptionTypeSchema, type OptionType } from './OptionType';
export { OptionValueSchema, type OptionValue } from './OptionValue';
export { OrderSchema, type Order } from './Order';
-export { OrderPromotionSchema, type OrderPromotion } from './OrderPromotion';
export { PaymentSchema, type Payment } from './Payment';
export { PaymentMethodSchema, type PaymentMethod } from './PaymentMethod';
export { PaymentSessionSchema, type PaymentSession } from './PaymentSession';
@@ -40,18 +34,11 @@ export { PriceSchema, type Price } from './Price';
export { ProductSchema, type Product } from './Product';
export { PromotionSchema, type Promotion } from './Promotion';
export { RefundSchema, type Refund } from './Refund';
-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 { ShippingCategorySchema, type ShippingCategory } from './ShippingCategory';
export { StateSchema, type State } from './State';
-export { StockItemSchema, type StockItem } from './StockItem';
export { StockLocationSchema, type StockLocation } from './StockLocation';
-export { StockMovementSchema, type StockMovement } from './StockMovement';
-export { StockTransferSchema, type StockTransfer } from './StockTransfer';
export { StoreCreditSchema, type StoreCredit } from './StoreCredit';
-export { TaxCategorySchema, type TaxCategory } from './TaxCategory';
export { VariantSchema, type Variant } from './Variant';
-export { WishedItemSchema, type WishedItem } from './WishedItem';
export { WishlistSchema, type Wishlist } from './Wishlist';
+export { WishlistItemSchema, type WishlistItem } from './WishlistItem';
diff --git a/packages/sdk/tests/customer.test.ts b/packages/sdk/tests/customer.test.ts
index f3ed8dd4ac..352365f7a7 100644
--- a/packages/sdk/tests/customer.test.ts
+++ b/packages/sdk/tests/customer.test.ts
@@ -64,11 +64,11 @@ describe('customer', () => {
it('creates an address', async () => {
const result = await client.customer.addresses.create(
{
- firstname: 'Test',
- lastname: 'User',
+ first_name: 'Test',
+ last_name: 'User',
address1: '123 Main St',
city: 'New York',
- zipcode: '10001',
+ postal_code: '10001',
country_iso: 'US',
},
opts
diff --git a/packages/sdk/tests/error-handling.test.ts b/packages/sdk/tests/error-handling.test.ts
index cac0bb58a9..7aa2cff857 100644
--- a/packages/sdk/tests/error-handling.test.ts
+++ b/packages/sdk/tests/error-handling.test.ts
@@ -58,7 +58,7 @@ describe('error handling', () => {
const client = createTestClient();
try {
await client.customer.addresses.create(
- { firstname: 'A', lastname: 'B', address1: '', city: '', zipcode: '00000', country_iso: 'US' },
+ { first_name: 'A', last_name: 'B', address1: '', city: '', postal_code: '00000', country_iso: 'US' },
{ token: 'jwt' }
);
expect.unreachable('Should have thrown');
diff --git a/packages/sdk/tests/mocks/handlers.ts b/packages/sdk/tests/mocks/handlers.ts
index b7764ac05e..14e2569b3e 100644
--- a/packages/sdk/tests/mocks/handlers.ts
+++ b/packages/sdk/tests/mocks/handlers.ts
@@ -54,11 +54,11 @@ export const fixtures = {
},
address: {
id: 'addr_1',
- firstname: 'Test',
- lastname: 'User',
+ first_name: 'Test',
+ last_name: 'User',
address1: '123 Main St',
city: 'New York',
- zipcode: '10001',
+ postal_code: '10001',
country_iso: 'US',
state_abbr: 'NY',
},
@@ -102,7 +102,7 @@ export const fixtures = {
is_private: false,
is_default: true,
},
- wishedItem: {
+ wishlistItem: {
id: 'wi_1',
quantity: 1,
variant_id: 'var_1',
@@ -278,7 +278,7 @@ export const handlers = [
display_amount: '$19.99',
source_type: 'credit_card',
source_id: 'card_1',
- source: { id: 'card_1', cc_type: 'visa', last_digits: '4242', name: 'Test User', month: '12', year: '2028' },
+ source: { id: 'card_1', brand: 'visa', last4: '4242', name: 'Test User', month: '12', year: '2028' },
created_at: '2026-02-17T00:00:00.000Z',
updated_at: '2026-02-17T00:00:00.000Z',
payment_method: { id: 'pm_1', name: 'Credit Card', description: null, type: 'Spree::Gateway::Bogus', session_required: true },
@@ -298,7 +298,7 @@ export const handlers = [
display_amount: '$19.99',
source_type: 'credit_card',
source_id: 'card_1',
- source: { id: 'card_1', cc_type: 'visa', last_digits: '4242', name: 'Test User', month: '12', year: '2028' },
+ source: { id: 'card_1', brand: 'visa', last4: '4242', name: 'Test User', month: '12', year: '2028' },
created_at: '2026-02-17T00:00:00.000Z',
updated_at: '2026-02-17T00:00:00.000Z',
payment_method: { id: 'pm_1', name: 'Credit Card', description: null, type: 'Spree::Gateway::Bogus', session_required: true },
@@ -455,7 +455,7 @@ export const handlers = [
),
http.get(`${API_PREFIX}/customer/credit_cards/:id`, () =>
- HttpResponse.json({ id: 'cc_1', last_digits: '1234' })
+ HttpResponse.json({ id: 'cc_1', last4: '1234' })
),
http.delete(`${API_PREFIX}/customer/credit_cards/:id`, () =>
@@ -558,11 +558,11 @@ export const handlers = [
// Wishlist Items
http.post(`${API_PREFIX}/wishlists/:wishlistId/items`, () =>
- HttpResponse.json(fixtures.wishedItem)
+ HttpResponse.json(fixtures.wishlistItem)
),
http.patch(`${API_PREFIX}/wishlists/:wishlistId/items/:id`, () =>
- HttpResponse.json({ ...fixtures.wishedItem, quantity: 3 })
+ HttpResponse.json({ ...fixtures.wishlistItem, quantity: 3 })
),
http.delete(`${API_PREFIX}/wishlists/:wishlistId/items/:id`, () =>
diff --git a/packages/sdk/tests/payments.test.ts b/packages/sdk/tests/payments.test.ts
index 4e69c98b88..1d7dd8de64 100644
--- a/packages/sdk/tests/payments.test.ts
+++ b/packages/sdk/tests/payments.test.ts
@@ -24,9 +24,9 @@ describe('payments', () => {
expect(payment.source).toBeDefined();
expect(payment.source!.id).toBe('card_1');
if (payment.source_type === 'credit_card') {
- const source = payment.source as { cc_type: string; last_digits: string };
- expect(source.cc_type).toBe('visa');
- expect(source.last_digits).toBe('4242');
+ const source = payment.source as { brand: string; last4: string };
+ expect(source.brand).toBe('visa');
+ expect(source.last4).toBe('4242');
}
});
diff --git a/spree/api/app/controllers/spree/api/v3/store/carts_controller.rb b/spree/api/app/controllers/spree/api/v3/store/carts_controller.rb
index 30e204e488..19e9d0c91f 100644
--- a/spree/api/app/controllers/spree/api/v3/store/carts_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/store/carts_controller.rb
@@ -140,13 +140,13 @@ module Spree
def permitted_params
params.permit(
:email,
- :special_instructions,
+ :customer_note,
:currency,
:locale,
- :ship_address_id,
- :bill_address_id,
- ship_address: address_params,
- bill_address: address_params,
+ :shipping_address_id,
+ :billing_address_id,
+ shipping_address: address_params,
+ billing_address: address_params,
metadata: {},
items: item_params
)
@@ -154,8 +154,9 @@ module Spree
def address_params
[
- :id, :firstname, :lastname, :address1, :address2,
- :city, :zipcode, :phone, :company,
+ :id, :first_name, :last_name,
+ :address1, :address2,
+ :city, :postal_code, :phone, :company,
:country_iso, :state_abbr, :state_name, :quick_checkout
]
end
diff --git a/spree/api/app/controllers/spree/api/v3/store/customer/addresses_controller.rb b/spree/api/app/controllers/spree/api/v3/store/customer/addresses_controller.rb
index 9c6d0de332..11374e693b 100644
--- a/spree/api/app/controllers/spree/api/v3/store/customer/addresses_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/store/customer/addresses_controller.rb
@@ -73,8 +73,8 @@ module Spree
def permitted_params
params.permit(
- :firstname, :lastname, :address1, :address2, :city,
- :zipcode, :phone, :company, :country_iso, :state_abbr, :state_name
+ :first_name, :last_name, :address1, :address2, :city,
+ :postal_code, :phone, :company, :country_iso, :state_abbr, :state_name
)
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/address_serializer.rb b/spree/api/app/serializers/spree/api/v3/address_serializer.rb
index d8d6a39ecf..fe8f9e6e14 100644
--- a/spree/api/app/serializers/spree/api/v3/address_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/address_serializer.rb
@@ -2,15 +2,15 @@ module Spree
module Api
module V3
class AddressSerializer < BaseSerializer
- typelize firstname: [:string, nullable: true], lastname: [:string, nullable: true], full_name: :string,
+ typelize first_name: [:string, nullable: true], last_name: [:string, nullable: true], full_name: :string,
address1: [:string, nullable: true], address2: [:string, nullable: true],
- city: [:string, nullable: true], zipcode: [:string, nullable: true], phone: [:string, nullable: true],
+ city: [:string, nullable: true], postal_code: [:string, nullable: true], phone: [:string, nullable: true],
company: [:string, nullable: true], state_abbr: [:string, nullable: true], state_name: [:string, nullable: true],
state_text: [:string, nullable: true], country_iso: :string, country_name: :string,
quick_checkout: :boolean
- attributes :firstname, :lastname, :full_name, :address1, :address2,
- :city, :zipcode, :phone, :company, :country_name, :country_iso, :state_text,
+ attributes :first_name, :last_name, :full_name, :address1, :address2, :postal_code,
+ :city, :phone, :company, :country_name, :country_iso, :state_text,
:state_abbr, :quick_checkout
# State name - used for countries without predefined states
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 ebadc8faf9..829eb8e8ca 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
@@ -4,7 +4,10 @@ module Spree
module Admin
class CreditCardSerializer < V3::CreditCardSerializer
typelize customer_id: [:string, nullable: true],
- payment_method_id: [:string, nullable: true]
+ payment_method_id: [:string, nullable: true],
+ gateway_payment_profile_id: [:string, nullable: true]
+
+ attributes :gateway_payment_profile_id
attribute :customer_id do |credit_card|
credit_card.user&.prefixed_id
diff --git a/spree/api/app/serializers/spree/api/v3/admin/order_promotion_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/discount_serializer.rb
similarity index 58%
rename from spree/api/app/serializers/spree/api/v3/admin/order_promotion_serializer.rb
rename to spree/api/app/serializers/spree/api/v3/admin/discount_serializer.rb
index 2f37650328..86dff25be8 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/order_promotion_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/discount_serializer.rb
@@ -2,7 +2,7 @@ module Spree
module Api
module V3
module Admin
- class OrderPromotionSerializer < V3::OrderPromotionSerializer
+ class DiscountSerializer < V3::DiscountSerializer
end
end
end
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 e321ac514a..9a915727a4 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
@@ -43,13 +43,13 @@ module Spree
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 :discounts, resource: Spree.api.admin_discount_serializer, if: proc { expand?('discounts') }
many :line_items, key: :items, resource: Spree.api.admin_line_item_serializer, if: proc { expand?('items') }
- many :shipments, key: :fulfillments, resource: Spree.api.admin_fulfillment_serializer, if: proc { expand?('fulfillments') }
+ many :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') }
- one :ship_address, resource: Spree.api.admin_address_serializer, if: proc { expand?('ship_address') }
+ one :billing_address, resource: Spree.api.admin_address_serializer, if: proc { expand?('billing_address') }
+ one :shipping_address, resource: Spree.api.admin_address_serializer, if: proc { expand?('shipping_address') }
many :payment_methods, resource: Spree.api.admin_payment_method_serializer, if: proc { expand?('payment_methods') }
diff --git a/spree/api/app/serializers/spree/api/v3/admin/payment_source_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/payment_source_serializer.rb
index fd96843c4f..7657555c06 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/payment_source_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/payment_source_serializer.rb
@@ -3,6 +3,11 @@ module Spree
module V3
module Admin
class PaymentSourceSerializer < V3::PaymentSourceSerializer
+ typelize gateway_payment_profile_id: [:string, nullable: true]
+
+ attribute :gateway_payment_profile_id do |source|
+ source.try(:gateway_payment_profile_id)
+ end
end
end
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 b9425f611f..b703ea9b43 100644
--- a/spree/api/app/serializers/spree/api/v3/cart_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/cart_serializer.rb
@@ -5,39 +5,33 @@ module Spree
# Pre-purchase cart data with checkout progression info
class CartSerializer < BaseSerializer
typelize number: :string, current_step: :string, completed_steps: 'string[]', token: :string, email: [:string, nullable: true],
- special_instructions: [:string, nullable: true], currency: :string, locale: [:string, nullable: true], item_count: :number,
+ customer_note: [:string, nullable: true], currency: :string, locale: [:string, nullable: true], total_quantity: :number,
requirements: 'Array<{step: string, field: string, message: string}>',
item_total: :string, display_item_total: :string,
delivery_total: :string, display_delivery_total: :string,
adjustment_total: :string, display_adjustment_total: :string,
- promo_total: :string, display_promo_total: :string,
+ discount_total: :string, display_discount_total: :string,
tax_total: :string, display_tax_total: :string,
included_tax_total: :string, display_included_tax_total: :string,
additional_tax_total: :string, display_additional_tax_total: :string,
total: :string, display_total: :string,
- bill_address: { nullable: true }, ship_address: { nullable: true }
+ billing_address: { nullable: true }, shipping_address: { nullable: true }
# Override ID to use cart_ prefix
attribute :id do |order|
"cart_#{Spree::PrefixedId::SQIDS.encode([order.id])}"
end
- attributes :number, :token, :email, :special_instructions,
- :currency, :locale, :item_count,
+ attributes :number, :token, :email, :customer_note,
+ :currency, :locale, :total_quantity,
:item_total, :display_item_total,
- :adjustment_total, :display_adjustment_total, :promo_total, :display_promo_total,
+ :adjustment_total, :display_adjustment_total,
+ :discount_total, :display_discount_total,
:tax_total, :display_tax_total, :included_tax_total, :display_included_tax_total,
:additional_tax_total, :display_additional_tax_total, :total, :display_total,
+ :delivery_total, :display_delivery_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
@@ -50,12 +44,12 @@ module Spree
Spree::Checkout::Requirements.new(order).call
end
- many :cart_promotions, key: :promotions, resource: Spree.api.cart_promotion_serializer
+ many :discounts, resource: Spree.api.discount_serializer
many :line_items, key: :items, resource: Spree.api.line_item_serializer
- many :shipments, key: :fulfillments, resource: Spree.api.fulfillment_serializer
+ many :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
+ one :billing_address, resource: Spree.api.address_serializer
+ one :shipping_address, resource: Spree.api.address_serializer
many :payment_methods, resource: Spree.api.payment_method_serializer
end
diff --git a/spree/api/app/serializers/spree/api/v3/credit_card_serializer.rb b/spree/api/app/serializers/spree/api/v3/credit_card_serializer.rb
index 38242abcfa..ecb67341ed 100644
--- a/spree/api/app/serializers/spree/api/v3/credit_card_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/credit_card_serializer.rb
@@ -2,10 +2,10 @@ module Spree
module Api
module V3
class CreditCardSerializer < BaseSerializer
- typelize cc_type: :string, last_digits: :string, month: :number, year: :number,
- name: [:string, nullable: true], default: :boolean, gateway_payment_profile_id: [:string, nullable: true]
+ typelize brand: :string, last4: :string, month: :number, year: :number,
+ name: [:string, nullable: true], default: :boolean
- attributes :cc_type, :last_digits, :month, :year, :name, :default, :gateway_payment_profile_id
+ attributes :brand, :last4, :month, :year, :name, :default
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/cart_promotion_serializer.rb b/spree/api/app/serializers/spree/api/v3/discount_serializer.rb
similarity index 54%
rename from spree/api/app/serializers/spree/api/v3/cart_promotion_serializer.rb
rename to spree/api/app/serializers/spree/api/v3/discount_serializer.rb
index 94c14575ee..a9ac036275 100644
--- a/spree/api/app/serializers/spree/api/v3/cart_promotion_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/discount_serializer.rb
@@ -1,14 +1,14 @@
module Spree
module Api
module V3
- # Cart-facing promotion serializer.
- # Same data as OrderPromotionSerializer but IDs use the cp_ prefix.
- class CartPromotionSerializer < BaseSerializer
+ # Unified discount serializer for applied promotions on Cart and Order.
+ # Replaces CartPromotionSerializer and OrderPromotionSerializer.
+ class DiscountSerializer < BaseSerializer
typelize name: :string, description: [:string, nullable: true], code: [:string, nullable: true],
amount: :string, display_amount: :string, promotion_id: :string
- attribute :promotion_id do |cart_promotion|
- cart_promotion.promotion&.prefixed_id
+ attribute :promotion_id do |record|
+ record.promotion&.prefixed_id
end
attributes :name, :description, :code, :amount, :display_amount
diff --git a/spree/api/app/serializers/spree/api/v3/line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/line_item_serializer.rb
index 22511dd4b0..894a23d320 100644
--- a/spree/api/app/serializers/spree/api/v3/line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/line_item_serializer.rb
@@ -8,7 +8,7 @@ module Spree
adjustment_total: :string, display_adjustment_total: :string,
additional_tax_total: :string, display_additional_tax_total: :string,
included_tax_total: :string, display_included_tax_total: :string,
- promo_total: :string, display_promo_total: :string,
+ discount_total: :string, display_discount_total: :string,
pre_tax_amount: :string, display_pre_tax_amount: :string,
discounted_amount: :string, display_discounted_amount: :string,
compare_at_amount: [:string, nullable: true], display_compare_at_amount: [:string, nullable: true],
@@ -23,7 +23,7 @@ module Spree
:adjustment_total, :display_adjustment_total,
:additional_tax_total, :display_additional_tax_total,
:included_tax_total, :display_included_tax_total,
- :promo_total, :display_promo_total,
+ :discount_total, :display_discount_total,
:pre_tax_amount, :display_pre_tax_amount,
:discounted_amount, :display_discounted_amount,
:display_compare_at_amount,
diff --git a/spree/api/app/serializers/spree/api/v3/option_type_serializer.rb b/spree/api/app/serializers/spree/api/v3/option_type_serializer.rb
index 4c1409ebfd..3f669fb070 100644
--- a/spree/api/app/serializers/spree/api/v3/option_type_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/option_type_serializer.rb
@@ -2,9 +2,9 @@ module Spree
module Api
module V3
class OptionTypeSerializer < BaseSerializer
- typelize name: :string, presentation: :string, position: :number
+ typelize name: :string, label: :string, position: :number
- attributes :name, :presentation, :position
+ attributes :name, :label, :position
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/option_value_serializer.rb b/spree/api/app/serializers/spree/api/v3/option_value_serializer.rb
index 964a248c62..1b0315e93a 100644
--- a/spree/api/app/serializers/spree/api/v3/option_value_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/option_value_serializer.rb
@@ -2,21 +2,21 @@ module Spree
module Api
module V3
class OptionValueSerializer < BaseSerializer
- typelize name: :string, presentation: :string, position: :number, option_type_id: :string,
- option_type_name: :string, option_type_presentation: :string
+ typelize name: :string, label: :string, position: :number, option_type_id: :string,
+ option_type_name: :string, option_type_label: :string
attribute :option_type_id do |option_value|
option_value.option_type&.prefixed_id
end
- attributes :name, :presentation, :position
+ attributes :name, :label, :position
attribute :option_type_name do |option_value|
option_value.option_type.name
end
- attribute :option_type_presentation do |option_value|
- option_value.option_type.presentation
+ attribute :option_type_label do |option_value|
+ option_value.option_type.label
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/order_promotion_serializer.rb b/spree/api/app/serializers/spree/api/v3/order_promotion_serializer.rb
deleted file mode 100644
index 4aa23d4503..0000000000
--- a/spree/api/app/serializers/spree/api/v3/order_promotion_serializer.rb
+++ /dev/null
@@ -1,16 +0,0 @@
-module Spree
- module Api
- module V3
- class OrderPromotionSerializer < BaseSerializer
- typelize name: :string, description: [:string, nullable: true], code: [:string, nullable: true],
- amount: :string, display_amount: :string, promotion_id: :string
-
- attribute :promotion_id do |order_promotion|
- order_promotion.promotion&.prefixed_id
- end
-
- attributes :name, :description, :code, :amount, :display_amount
- end
- end
- 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 39fccd592b..a9b1253a3e 100644
--- a/spree/api/app/serializers/spree/api/v3/order_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/order_serializer.rb
@@ -5,48 +5,34 @@ module Spree
# Post-purchase order data (completed orders)
class OrderSerializer < BaseSerializer
typelize number: :string, email: :string,
- special_instructions: [:string, nullable: true], currency: :string, locale: [:string, nullable: true], item_count: :number,
+ customer_note: [:string, nullable: true], currency: :string, locale: [:string, nullable: true], total_quantity: :number,
fulfillment_status: [:string, nullable: true], payment_status: [:string, nullable: true],
item_total: :string, display_item_total: :string,
delivery_total: :string, display_delivery_total: :string,
adjustment_total: :string, display_adjustment_total: :string,
- promo_total: :string, display_promo_total: :string,
+ discount_total: :string, display_discount_total: :string,
tax_total: :string, display_tax_total: :string,
included_tax_total: :string, display_included_tax_total: :string,
additional_tax_total: :string, display_additional_tax_total: :string,
total: :string, display_total: :string, completed_at: [:string, nullable: true],
- bill_address: { nullable: true }, ship_address: { nullable: true }
+ billing_address: { nullable: true }, shipping_address: { nullable: true }
- attributes :number, :email, :special_instructions,
- :currency, :locale, :item_count,
+ attributes :number, :email, :customer_note,
+ :currency, :locale, :total_quantity,
:item_total, :display_item_total,
- :adjustment_total, :display_adjustment_total, :promo_total, :display_promo_total,
+ :adjustment_total, :display_adjustment_total,
+ :discount_total, :display_discount_total,
:tax_total, :display_tax_total, :included_tax_total, :display_included_tax_total,
:additional_tax_total, :display_additional_tax_total, :total, :display_total,
+ :delivery_total, :display_delivery_total, :fulfillment_status, :payment_status,
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 :discounts, resource: Spree.api.discount_serializer
many :line_items, key: :items, resource: Spree.api.line_item_serializer
- many :shipments, key: :fulfillments, resource: Spree.api.fulfillment_serializer
+ many :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
+ one :billing_address, resource: Spree.api.address_serializer
+ one :shipping_address, resource: Spree.api.address_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/payment_source_serializer.rb b/spree/api/app/serializers/spree/api/v3/payment_source_serializer.rb
index 7e83c2f5a2..c1250712e5 100644
--- a/spree/api/app/serializers/spree/api/v3/payment_source_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/payment_source_serializer.rb
@@ -2,11 +2,7 @@ module Spree
module Api
module V3
class PaymentSourceSerializer < BaseSerializer
- typelize gateway_payment_profile_id: [:string, nullable: true]
-
- attribute :gateway_payment_profile_id do |source|
- source.try(:gateway_payment_profile_id)
- end
+ # gateway_payment_profile_id moved to Admin API only
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/promotion_serializer.rb b/spree/api/app/serializers/spree/api/v3/promotion_serializer.rb
index 5fb4786063..9bd87a1a2f 100644
--- a/spree/api/app/serializers/spree/api/v3/promotion_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/promotion_serializer.rb
@@ -3,25 +3,13 @@
module Spree
module Api
module V3
+ # Store API Promotion Serializer
+ # Minimal public-facing promotion info. Full details in Admin serializer.
class PromotionSerializer < BaseSerializer
typelize name: :string, description: [:string, nullable: true],
- code: [:string, nullable: true], type: [:string, nullable: true],
- kind: [:string, nullable: true], path: [:string, nullable: true],
- match_policy: [:string, nullable: true], usage_limit: [:number, nullable: true],
- advertise: :boolean, multi_codes: :boolean,
- code_prefix: [:string, nullable: true], number_of_codes: [:number, nullable: true],
- starts_at: [:string, nullable: true], expires_at: [:string, nullable: true],
- promotion_category_id: [:string, nullable: true]
+ code: [:string, nullable: true]
- attributes :name, :description, :code, :type, :kind, :path,
- :match_policy, :usage_limit, :advertise, :multi_codes,
- :code_prefix, :number_of_codes,
- starts_at: :iso8601, expires_at: :iso8601,
- created_at: :iso8601, updated_at: :iso8601
-
- attribute :promotion_category_id do |promotion|
- promotion.promotion_category&.prefixed_id
- end
+ attributes :name, :description, :code
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/return_authorization_serializer.rb b/spree/api/app/serializers/spree/api/v3/return_authorization_serializer.rb
index d97b535c85..a6c3d4a212 100644
--- a/spree/api/app/serializers/spree/api/v3/return_authorization_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/return_authorization_serializer.rb
@@ -4,13 +4,13 @@ module Spree
module Api
module V3
class ReturnAuthorizationSerializer < BaseSerializer
- typelize number: :string, state: :string,
+ typelize number: :string, status: :string,
order_id: [:string, nullable: true], stock_location_id: [:string, nullable: true],
return_authorization_reason_id: [:string, nullable: true]
attributes :number, created_at: :iso8601, updated_at: :iso8601
- attribute :state do |return_authorization|
+ attribute :status do |return_authorization|
return_authorization.state.to_s
end
diff --git a/spree/api/app/serializers/spree/api/v3/wished_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/wishlist_item_serializer.rb
similarity index 90%
rename from spree/api/app/serializers/spree/api/v3/wished_item_serializer.rb
rename to spree/api/app/serializers/spree/api/v3/wishlist_item_serializer.rb
index 032015db1c..32dcabd02c 100644
--- a/spree/api/app/serializers/spree/api/v3/wished_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/wishlist_item_serializer.rb
@@ -1,7 +1,7 @@
module Spree
module Api
module V3
- class WishedItemSerializer < BaseSerializer
+ class WishlistItemSerializer < BaseSerializer
typelize variant_id: :string, wishlist_id: :string, quantity: :number
attribute :variant_id do |wished_item|
diff --git a/spree/api/app/serializers/spree/api/v3/wishlist_serializer.rb b/spree/api/app/serializers/spree/api/v3/wishlist_serializer.rb
index eccd79039a..3c1a7b35b4 100644
--- a/spree/api/app/serializers/spree/api/v3/wishlist_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/wishlist_serializer.rb
@@ -17,7 +17,7 @@ module Spree
many :wished_items,
key: :items,
- resource: Spree.api.wished_item_serializer,
+ resource: Spree.api.wishlist_item_serializer,
if: proc { expand?('items') }
end
end
diff --git a/spree/api/app/services/spree/api/v3/filters_aggregator.rb b/spree/api/app/services/spree/api/v3/filters_aggregator.rb
index 0814abccc1..94d426e719 100644
--- a/spree/api/app/services/spree/api/v3/filters_aggregator.rb
+++ b/spree/api/app/services/spree/api/v3/filters_aggregator.rb
@@ -85,7 +85,7 @@ module Spree
id: option_type.prefixed_id,
type: 'option',
name: option_type.name,
- presentation: option_type.presentation,
+ label: option_type.label,
options: values.map { |ov| option_value_data(option_type, ov) }
}
end
@@ -105,7 +105,7 @@ module Spree
{
id: option_value.prefixed_id,
name: option_value.name,
- presentation: option_value.presentation,
+ label: option_value.label,
position: option_value.position,
count: count
}
diff --git a/spree/api/config/initializers/typelizer.rb b/spree/api/config/initializers/typelizer.rb
index 8d3c416808..306b662aa6 100644
--- a/spree/api/config/initializers/typelizer.rb
+++ b/spree/api/config/initializers/typelizer.rb
@@ -10,10 +10,22 @@ Rails.application.config.after_initialize do
config.comments = true
config.listen = false
+ # Serializers that exist only for Admin API or events — no Store API controller
+ store_excluded = %w[
+ Asset CartPromotion OrderPromotion
+ StockItem StockMovement StockTransfer ShippingCategory
+ Reimbursement Report Export Import ImportRow
+ TaxCategory CustomerReturn
+ ].to_set
+
# Store SDK — no prefix, package provides namespace
config.writer(:store) do |c|
c.output_dir = api_root.join('../../packages/sdk/src/types/generated')
- c.reject_class = ->(serializer:) { serializer.name.to_s.include?('::Admin::') }
+ c.reject_class = ->(serializer:) {
+ name = serializer.name.to_s
+ name.include?('::Admin::') ||
+ store_excluded.include?(name.sub(/\ASpree::Api::V3::/, '').sub(/Serializer\z/, ''))
+ }
c.serializer_name_mapper = ->(serializer) {
serializer.name.to_s
.sub(/\ASpree::Api::V3::/, '')
diff --git a/spree/api/lib/spree/api/dependencies.rb b/spree/api/lib/spree/api/dependencies.rb
index 3705e60921..b6d2911a4a 100644
--- a/spree/api/lib/spree/api/dependencies.rb
+++ b/spree/api/lib/spree/api/dependencies.rb
@@ -115,7 +115,8 @@ module Spree
market_serializer: 'Spree::Api::V3::MarketSerializer',
state_serializer: 'Spree::Api::V3::StateSerializer',
wishlist_serializer: 'Spree::Api::V3::WishlistSerializer',
- wished_item_serializer: 'Spree::Api::V3::WishedItemSerializer',
+ wishlist_item_serializer: 'Spree::Api::V3::WishlistItemSerializer',
+ wished_item_serializer: 'Spree::Api::V3::WishlistItemSerializer',
payment_method_serializer: 'Spree::Api::V3::PaymentMethodSerializer',
shipping_method_serializer: 'Spree::Api::V3::DeliveryMethodSerializer',
shipping_rate_serializer: 'Spree::Api::V3::DeliveryRateSerializer',
@@ -123,8 +124,7 @@ module Spree
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',
- order_promotion_serializer: 'Spree::Api::V3::OrderPromotionSerializer',
+ discount_serializer: 'Spree::Api::V3::DiscountSerializer',
digital_link_serializer: 'Spree::Api::V3::DigitalLinkSerializer',
gift_card_serializer: 'Spree::Api::V3::GiftCardSerializer',
currency_serializer: 'Spree::Api::V3::CurrencySerializer',
@@ -154,6 +154,7 @@ module Spree
stock_transfer_serializer: 'Spree::Api::V3::StockTransferSerializer',
# v3 admin serializers (API v3 Admin)
+ admin_discount_serializer: 'Spree::Api::V3::Admin::DiscountSerializer',
admin_customer_serializer: 'Spree::Api::V3::Admin::CustomerSerializer',
admin_order_serializer: 'Spree::Api::V3::Admin::OrderSerializer',
admin_product_serializer: 'Spree::Api::V3::Admin::ProductSerializer',
@@ -183,7 +184,6 @@ module Spree
admin_stock_location_serializer: 'Spree::Api::V3::Admin::StockLocationSerializer',
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',
admin_store_credit_serializer: 'Spree::Api::V3::Admin::StoreCreditSerializer',
diff --git a/spree/api/spec/controllers/spree/api/v3/store/carts/items_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/carts/items_controller_spec.rb
index 6ddd4e94b5..982af17db2 100644
--- a/spree/api/spec/controllers/spree/api/v3/store/carts/items_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/store/carts/items_controller_spec.rb
@@ -22,14 +22,14 @@ RSpec.describe Spree::Api::V3::Store::Carts::ItemsController, type: :controller
expect(response).to have_http_status(:created)
expect(json_response['id']).to start_with('cart_')
- expect(json_response['item_count']).to eq(2)
+ expect(json_response['total_quantity']).to eq(2)
end
it 'defaults quantity to 1' do
post :create, params: { cart_id: order.prefixed_id, variant_id: variant.prefixed_id }
expect(response).to have_http_status(:created)
- expect(json_response['item_count']).to eq(1)
+ expect(json_response['total_quantity']).to eq(1)
end
it 'returns updated totals' do
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 4b003298ed..2261485a32 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
@@ -352,7 +352,7 @@ RSpec.describe Spree::Api::V3::Store::CartsController, type: :controller do
'requirements',
'token',
'currency',
- 'item_count',
+ 'total_quantity',
'item_total',
'display_item_total',
'total',
@@ -432,11 +432,11 @@ RSpec.describe Spree::Api::V3::Store::CartsController, type: :controller do
request.headers['Authorization'] = "Bearer #{jwt_token}"
end
- it 'accepts ship_address_id to use an existing address' do
+ it 'accepts shipping_address_id to use an existing address' do
order.update!(email: '[email protected]')
existing_address = user.addresses.first || create(:address, user: user, country: country, state: us_state)
- patch :update, params: { id: order.prefixed_id, ship_address_id: existing_address.prefixed_id }
+ patch :update, params: { id: order.prefixed_id, shipping_address_id: existing_address.prefixed_id }
expect(response).to have_http_status(:ok)
expect(order.reload.ship_address_id).to eq(existing_address.id)
@@ -450,10 +450,10 @@ RSpec.describe Spree::Api::V3::Store::CartsController, type: :controller do
patch :update, params: {
id: order.prefixed_id,
- ship_address: {
- firstname: 'John', lastname: 'Doe',
+ shipping_address: {
+ first_name: 'John', last_name: 'Doe',
address1: '123 Main St', city: 'New York',
- zipcode: '10001', country_iso: 'US', state_abbr: 'NY',
+ postal_code: '10001', country_iso: 'US', state_abbr: 'NY',
phone: '555-1234'
}
}
diff --git a/spree/api/spec/controllers/spree/api/v3/store/customer/addresses_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/customer/addresses_controller_spec.rb
index e48081bec0..e13de5e7f4 100644
--- a/spree/api/spec/controllers/spree/api/v3/store/customer/addresses_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/store/customer/addresses_controller_spec.rb
@@ -26,7 +26,7 @@ RSpec.describe Spree::Api::V3::Store::Customer::AddressesController, type: :cont
get :index
address_data = json_response['data'].first
- expect(address_data).to include('id', 'firstname', 'lastname', 'address1', 'city', 'zipcode')
+ expect(address_data).to include('id', 'first_name', 'last_name', 'address1', 'city', 'postal_code')
end
it 'only returns addresses belonging to the current user' do
@@ -62,7 +62,7 @@ RSpec.describe Spree::Api::V3::Store::Customer::AddressesController, type: :cont
it 'returns address attributes' do
get :show, params: { id: address.prefixed_id }
- expect(json_response).to include('id', 'firstname', 'lastname', 'address1', 'city', 'zipcode')
+ expect(json_response).to include('id', 'first_name', 'last_name', 'address1', 'city', 'postal_code')
end
context 'when address belongs to another user' do
@@ -90,11 +90,11 @@ RSpec.describe Spree::Api::V3::Store::Customer::AddressesController, type: :cont
describe 'POST #create' do
let(:address_params) do
{
- firstname: 'John',
- lastname: 'Doe',
+ first_name: 'John',
+ last_name: 'Doe',
address1: '123 Main St',
city: 'New York',
- zipcode: '10001',
+ postal_code: '10001',
phone: '555-1234',
country_iso: country.iso,
state_abbr: state.abbr
@@ -112,14 +112,14 @@ RSpec.describe Spree::Api::V3::Store::Customer::AddressesController, type: :cont
it 'returns the created address' do
post :create, params: address_params
- expect(json_response['firstname']).to eq('John')
- expect(json_response['lastname']).to eq('Doe')
+ expect(json_response['first_name']).to eq('John')
+ expect(json_response['last_name']).to eq('Doe')
expect(json_response['address1']).to eq('123 Main St')
end
context 'with invalid params' do
- it 'returns validation errors for missing firstname' do
- post :create, params: address_params.except(:firstname)
+ it 'returns validation errors for missing first_name' do
+ post :create, params: address_params.except(:first_name)
expect(response).to have_http_status(:unprocessable_content)
expect(json_response['error']['code']).to eq('validation_error')
@@ -139,16 +139,16 @@ RSpec.describe Spree::Api::V3::Store::Customer::AddressesController, type: :cont
describe 'PATCH #update' do
it 'updates the address' do
- patch :update, params: { id: address.prefixed_id, firstname: 'Updated' }
+ patch :update, params: { id: address.prefixed_id, first_name: 'Updated' }
expect(response).to have_http_status(:ok)
expect(address.reload.firstname).to eq('Updated')
end
it 'returns the updated address' do
- patch :update, params: { id: address.prefixed_id, firstname: 'Updated' }
+ patch :update, params: { id: address.prefixed_id, first_name: 'Updated' }
- expect(json_response['firstname']).to eq('Updated')
+ expect(json_response['first_name']).to eq('Updated')
end
context 'when address belongs to another user' do
@@ -156,7 +156,7 @@ RSpec.describe Spree::Api::V3::Store::Customer::AddressesController, type: :cont
let(:other_address) { create(:address, user: other_user) }
it 'returns not found' do
- patch :update, params: { id: other_address.prefixed_id, firstname: 'Hacker' }
+ patch :update, params: { id: other_address.prefixed_id, first_name: 'Hacker' }
expect(response).to have_http_status(:not_found)
expect(other_address.reload.firstname).not_to eq('Hacker')
@@ -167,7 +167,7 @@ RSpec.describe Spree::Api::V3::Store::Customer::AddressesController, type: :cont
before { request.headers['Authorization'] = nil }
it 'returns unauthorized' do
- patch :update, params: { id: address.prefixed_id, firstname: 'Updated' }
+ patch :update, params: { id: address.prefixed_id, first_name: 'Updated' }
expect(response).to have_http_status(:unauthorized)
end
diff --git a/spree/api/spec/controllers/spree/api/v3/store/customer/credit_cards_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/customer/credit_cards_controller_spec.rb
index 3153bcda96..5b87834d6d 100644
--- a/spree/api/spec/controllers/spree/api/v3/store/customer/credit_cards_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/store/customer/credit_cards_controller_spec.rb
@@ -24,7 +24,7 @@ RSpec.describe Spree::Api::V3::Store::Customer::CreditCardsController, type: :co
get :index
card_data = json_response['data'].first
- expect(card_data).to include('id', 'last_digits', 'month', 'year', 'cc_type')
+ expect(card_data).to include('id', 'last4', 'month', 'year', 'brand')
end
it 'only returns credit cards belonging to the current user' do
diff --git a/spree/api/spec/controllers/spree/api/v3/store/products/filters_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/products/filters_controller_spec.rb
index 124abc958b..0509e609a3 100644
--- a/spree/api/spec/controllers/spree/api/v3/store/products/filters_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/store/products/filters_controller_spec.rb
@@ -82,12 +82,12 @@ RSpec.describe Spree::Api::V3::Store::Products::FiltersController, type: :contro
size_filter = json_response['filters'].find { |f| f['name'] == 'size' }
expect(size_filter).to be_present
expect(size_filter['type']).to eq('option')
- expect(size_filter['presentation']).to eq('Size')
+ expect(size_filter['label']).to eq('Size')
size_options = size_filter['options']
- expect(size_options.map { |o| o['presentation'] }).to include('S', 'M')
+ expect(size_options.map { |o| o['label'] }).to include('S', 'M')
- small_option = size_options.find { |o| o['presentation'] == 'S' }
+ small_option = size_options.find { |o| o['label'] == 'S' }
expect(small_option['count']).to eq(1)
end
diff --git a/spree/api/spec/integration/spree/api/v3/store/addresses_spec.rb b/spree/api/spec/integration/spree/api/v3/store/addresses_spec.rb
index 06d300db06..6ca198a774 100644
--- a/spree/api/spec/integration/spree/api/v3/store/addresses_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/store/addresses_spec.rb
@@ -64,11 +64,11 @@ RSpec.describe 'Addresses API', type: :request, swagger_doc: 'api-reference/stor
sdk_example <<~JS
const address = await client.customer.addresses.create({
- firstname: 'John',
- lastname: 'Doe',
+ first_name: 'John',
+ last_name: 'Doe',
address1: '123 Main St',
city: 'New York',
- zipcode: '10001',
+ postal_code: '10001',
country_iso: 'US',
state_abbr: 'NY',
phone: '+1 555 123 4567',
@@ -82,19 +82,19 @@ RSpec.describe 'Addresses API', type: :request, swagger_doc: 'api-reference/stor
parameter name: :body, in: :body, schema: {
type: :object,
properties: {
- firstname: { type: :string, example: 'John' },
- lastname: { type: :string, example: 'Doe' },
+ first_name: { type: :string, example: 'John' },
+ last_name: { type: :string, example: 'Doe' },
address1: { type: :string, example: '123 Main St' },
address2: { type: :string, example: 'Apt 4B' },
city: { type: :string, example: 'New York' },
- zipcode: { type: :string, example: '10001' },
+ postal_code: { type: :string, example: '10001' },
phone: { type: :string, example: '+1 555 123 4567' },
company: { type: :string, example: 'Acme Inc' },
country_iso: { type: :string, example: 'US', description: 'ISO 3166-1 alpha-2 country code (e.g., "US", "DE")' },
state_abbr: { type: :string, example: 'NY', description: 'ISO 3166-2 subdivision code without country prefix (e.g., "CA", "NY")' },
state_name: { type: :string, example: 'New York', description: 'State name - for countries without predefined states' }
},
- required: %w[firstname lastname address1 city zipcode country_iso]
+ required: %w[first_name last_name address1 city postal_code country_iso]
}
response '201', 'address created' do
@@ -102,11 +102,11 @@ RSpec.describe 'Addresses API', type: :request, swagger_doc: 'api-reference/stor
let(:'Authorization') { "Bearer #{jwt_token}" }
let(:body) do
{
- firstname: 'John',
- lastname: 'Doe',
+ first_name: 'John',
+ last_name: 'Doe',
address1: '123 Main St',
city: 'New York',
- zipcode: '10001',
+ postal_code: '10001',
phone: '+1 555 123 4567',
country_iso: country.iso,
state_abbr: state.abbr
@@ -117,7 +117,7 @@ RSpec.describe 'Addresses API', type: :request, swagger_doc: 'api-reference/stor
run_test! do |response|
data = JSON.parse(response.body)
- expect(data['firstname']).to eq('John')
+ expect(data['first_name']).to eq('John')
expect(data['city']).to eq('New York')
expect(data['country_iso']).to eq(country.iso)
expect(data['state_abbr']).to eq(state.abbr)
@@ -127,7 +127,7 @@ RSpec.describe 'Addresses API', type: :request, swagger_doc: 'api-reference/stor
response '422', 'validation error' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:body) { { firstname: '' } }
+ let(:body) { { first_name: '' } }
schema '$ref' => '#/components/schemas/ErrorResponse'
@@ -195,8 +195,8 @@ RSpec.describe 'Addresses API', type: :request, swagger_doc: 'api-reference/stor
parameter name: :body, in: :body, schema: {
type: :object,
properties: {
- firstname: { type: :string, example: 'John' },
- lastname: { type: :string, example: 'Doe' },
+ first_name: { type: :string, example: 'John' },
+ last_name: { type: :string, example: 'Doe' },
address1: { type: :string, example: '456 Oak Ave' },
city: { type: :string, example: 'Los Angeles' }
}
diff --git a/spree/api/spec/integration/spree/api/v3/store/carts_spec.rb b/spree/api/spec/integration/spree/api/v3/store/carts_spec.rb
index efddb1943f..f54a9d92d4 100644
--- a/spree/api/spec/integration/spree/api/v3/store/carts_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/store/carts_spec.rb
@@ -164,17 +164,17 @@ RSpec.describe 'Carts API', type: :request, swagger_doc: 'api-reference/store.ya
consumes 'application/json'
produces 'application/json'
security [api_key: [], bearer_auth: []]
- description 'Updates cart info (email, addresses, special instructions). When addresses change, the order state is reverted to address to ensure shipments are recalculated.'
+ description 'Updates cart info (email, addresses, customer note). When addresses change, the order state is reverted to address to ensure shipments are recalculated.'
sdk_example <<~JS
const cart = await client.carts.update('cart_abc123', {
- ship_address: {
- firstname: 'John',
- lastname: 'Doe',
+ shipping_address: {
+ first_name: 'John',
+ last_name: 'Doe',
address1: '123 Main St',
city: 'New York',
- zipcode: '10001',
+ postal_code: '10001',
country_iso: 'US',
state_abbr: 'NY',
},
@@ -192,26 +192,26 @@ RSpec.describe 'Carts API', type: :request, swagger_doc: 'api-reference/store.ya
type: :object,
properties: {
email: { type: :string, format: 'email', example: '[email protected]' },
- special_instructions: { type: :string, example: 'Leave at door' },
+ customer_note: { type: :string, example: 'Leave at door' },
metadata: { type: :object, additionalProperties: true },
- ship_address_id: { type: :string, description: 'Existing address ID to use as shipping address', example: 'addr_abc123' },
- bill_address_id: { type: :string, description: 'Existing address ID to use as billing address', example: 'addr_def456' },
- bill_address: {
+ shipping_address_id: { type: :string, description: 'Existing address ID to use as shipping address', example: 'addr_abc123' },
+ billing_address_id: { type: :string, description: 'Existing address ID to use as billing address', example: 'addr_def456' },
+ billing_address: {
type: :object,
properties: {
- firstname: { type: :string }, lastname: { type: :string },
+ first_name: { type: :string }, last_name: { type: :string },
address1: { type: :string }, address2: { type: :string },
- city: { type: :string }, zipcode: { type: :string },
+ city: { type: :string }, postal_code: { type: :string },
phone: { type: :string }, company: { type: :string },
country_iso: { type: :string }, state_abbr: { type: :string }
}
},
- ship_address: {
+ shipping_address: {
type: :object,
properties: {
- firstname: { type: :string }, lastname: { type: :string },
+ first_name: { type: :string }, last_name: { type: :string },
address1: { type: :string }, address2: { type: :string },
- city: { type: :string }, zipcode: { type: :string },
+ city: { type: :string }, postal_code: { type: :string },
phone: { type: :string }, company: { type: :string },
country_iso: { type: :string }, state_abbr: { type: :string }
}
@@ -224,14 +224,14 @@ RSpec.describe 'Carts API', type: :request, swagger_doc: 'api-reference/store.ya
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
let(:id) { order.prefixed_id }
- let(:body) { { special_instructions: 'Leave at door' } }
+ let(:body) { { customer_note: 'Leave at door' } }
schema '$ref' => '#/components/schemas/Cart'
run_test! do |response|
data = JSON.parse(response.body)
expect(data['id']).to start_with('cart_')
- expect(data['special_instructions']).to eq('Leave at door')
+ expect(data['customer_note']).to eq('Leave at door')
end
end
end
diff --git a/spree/api/spec/integration/spree/api/v3/store/credit_cards_spec.rb b/spree/api/spec/integration/spree/api/v3/store/credit_cards_spec.rb
index eb5a290627..63dedc9caf 100644
--- a/spree/api/spec/integration/spree/api/v3/store/credit_cards_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/store/credit_cards_spec.rb
@@ -40,7 +40,7 @@ RSpec.describe 'Credit Cards API', type: :request, swagger_doc: 'api-reference/s
run_test! do |response|
data = JSON.parse(response.body)
expect(data['data']).to be_an(Array)
- expect(data['data'].first).to include('id', 'cc_type', 'last_digits', 'month', 'year')
+ expect(data['data'].first).to include('id', 'brand', 'last4', 'month', 'year')
end
end
diff --git a/spree/api/spec/integration/spree/api/v3/store/wishlists_spec.rb b/spree/api/spec/integration/spree/api/v3/store/wishlists_spec.rb
index 1e8705c700..5e823d55c6 100644
--- a/spree/api/spec/integration/spree/api/v3/store/wishlists_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/store/wishlists_spec.rb
@@ -255,7 +255,7 @@ RSpec.describe 'Wishlists API', type: :request, swagger_doc: 'api-reference/stor
let(:wishlist_id) { wishlist.to_param }
let(:body) { { variant_id: new_variant.prefixed_id, quantity: 1 } }
- schema '$ref' => '#/components/schemas/WishedItem'
+ schema '$ref' => '#/components/schemas/WishlistItem'
run_test!
end
diff --git a/spree/api/spec/serializers/spree/api/v3/credit_card_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/credit_card_serializer_spec.rb
index 383477e659..734434675c 100644
--- a/spree/api/spec/serializers/spree/api/v3/credit_card_serializer_spec.rb
+++ b/spree/api/spec/serializers/spree/api/v3/credit_card_serializer_spec.rb
@@ -17,7 +17,7 @@ RSpec.describe Spree::Api::V3::CreditCardSerializer do
it 'includes all expected attributes' do
expect(subject.keys).to match_array(%w[
- id cc_type last_digits month year name default gateway_payment_profile_id
+ id brand last4 month year name default
])
end
@@ -26,21 +26,16 @@ RSpec.describe Spree::Api::V3::CreditCardSerializer do
end
it 'returns correct attribute values' do
- expect(subject['cc_type']).to eq('visa')
- expect(subject['last_digits']).to eq('1111')
+ expect(subject['brand']).to eq('visa')
+ expect(subject['last4']).to eq('1111')
expect(subject['month']).to eq(12)
expect(subject['year']).to eq(1.year.from_now.year)
expect(subject['name']).to eq('John Doe')
expect(subject['default']).to be true
- expect(subject['gateway_payment_profile_id']).to eq('pm_abc123')
end
- context 'without gateway_payment_profile_id' do
- let(:credit_card) { create(:credit_card, gateway_payment_profile_id: nil) }
-
- it 'returns nil for gateway_payment_profile_id' do
- expect(subject['gateway_payment_profile_id']).to be_nil
- end
+ it 'does not expose gateway_payment_profile_id' do
+ expect(subject).not_to have_key('gateway_payment_profile_id')
end
context 'without name' do
diff --git a/spree/api/spec/serializers/spree/api/v3/line_item_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/line_item_serializer_spec.rb
index b472b9b5f1..5942f087f3 100644
--- a/spree/api/spec/serializers/spree/api/v3/line_item_serializer_spec.rb
+++ b/spree/api/spec/serializers/spree/api/v3/line_item_serializer_spec.rb
@@ -32,8 +32,8 @@ RSpec.describe Spree::Api::V3::LineItemSerializer do
it 'includes adjustment attributes' do
expect(subject).to have_key('adjustment_total')
expect(subject).to have_key('display_adjustment_total')
- expect(subject).to have_key('promo_total')
- expect(subject).to have_key('display_promo_total')
+ expect(subject).to have_key('discount_total')
+ expect(subject).to have_key('display_discount_total')
end
it 'includes tax attributes' do
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 b597d75b6c..5aafd764f6 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
@@ -53,8 +53,8 @@ RSpec.describe Spree::Api::V3::PaymentSerializer do
it 'serializes the credit card source' do
expect(subject['source']).to be_a(Hash)
expect(subject['source']['id']).to eq(payment.source.prefixed_id)
- expect(subject['source']).to have_key('cc_type')
- expect(subject['source']).to have_key('last_digits')
+ expect(subject['source']).to have_key('brand')
+ expect(subject['source']).to have_key('last4')
expect(subject['source']).to have_key('month')
expect(subject['source']).to have_key('year')
expect(subject['source']).to have_key('name')
@@ -75,7 +75,7 @@ RSpec.describe Spree::Api::V3::PaymentSerializer do
it 'serializes the payment source' do
expect(subject['source']).to be_a(Hash)
expect(subject['source']['id']).to eq(payment.source.prefixed_id)
- expect(subject['source']).to have_key('gateway_payment_profile_id')
+ expect(subject['source']).not_to have_key('gateway_payment_profile_id')
expect(subject['source']).not_to have_key('public_metadata')
end
end
diff --git a/spree/api/spec/serializers/spree/api/v3/payment_source_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/payment_source_serializer_spec.rb
index 472ef13dfd..7bebb81fa8 100644
--- a/spree/api/spec/serializers/spree/api/v3/payment_source_serializer_spec.rb
+++ b/spree/api/spec/serializers/spree/api/v3/payment_source_serializer_spec.rb
@@ -12,26 +12,16 @@ RSpec.describe Spree::Api::V3::PaymentSourceSerializer do
subject { described_class.new(payment_source, params: base_params).to_h }
- it 'includes all expected attributes' do
- expect(subject.keys).to match_array(%w[
- id gateway_payment_profile_id
- ])
+ it 'includes only the id attribute' do
+ expect(subject.keys).to match_array(%w[id])
end
it 'returns the prefixed id' do
expect(subject['id']).to eq(payment_source.prefixed_id)
end
- it 'returns correct attribute values' do
- expect(subject['gateway_payment_profile_id']).to eq('pp_abc123')
- end
-
- context 'without gateway_payment_profile_id' do
- let(:payment_source) { create(:payment_source, payment_method: payment_method, gateway_payment_profile_id: nil) }
-
- it 'returns nil for gateway_payment_profile_id' do
- expect(subject['gateway_payment_profile_id']).to be_nil
- end
+ it 'does not expose gateway_payment_profile_id' do
+ expect(subject).not_to have_key('gateway_payment_profile_id')
end
it 'does not expose metadata in Store API responses' do
diff --git a/spree/api/spec/serializers/spree/api/v3/promotion_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/promotion_serializer_spec.rb
index cc06e65c3f..33dbb28701 100644
--- a/spree/api/spec/serializers/spree/api/v3/promotion_serializer_spec.rb
+++ b/spree/api/spec/serializers/spree/api/v3/promotion_serializer_spec.rb
@@ -11,9 +11,7 @@ RSpec.describe Spree::Api::V3::PromotionSerializer do
it 'includes all expected attributes' do
expect(subject.keys).to match_array(%w[
- id name description code type kind path match_policy usage_limit
- advertise multi_codes code_prefix number_of_codes
- starts_at expires_at promotion_category_id created_at updated_at
+ id name description code
])
end
diff --git a/spree/api/spec/serializers/spree/api/v3/return_authorization_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/return_authorization_serializer_spec.rb
index 8f05cd140f..75c299c5f3 100644
--- a/spree/api/spec/serializers/spree/api/v3/return_authorization_serializer_spec.rb
+++ b/spree/api/spec/serializers/spree/api/v3/return_authorization_serializer_spec.rb
@@ -11,7 +11,7 @@ RSpec.describe Spree::Api::V3::ReturnAuthorizationSerializer do
it 'includes all expected attributes' do
expect(subject.keys).to match_array(%w[
- id number state order_id stock_location_id return_authorization_reason_id created_at updated_at
+ id number status order_id stock_location_id return_authorization_reason_id created_at updated_at
])
end
@@ -23,7 +23,7 @@ RSpec.describe Spree::Api::V3::ReturnAuthorizationSerializer do
expect(subject['order_id']).to eq(return_authorization.order.prefixed_id)
end
- it 'returns state as string' do
- expect(subject['state']).to be_a(String)
+ it 'returns status as string' do
+ expect(subject['status']).to be_a(String)
end
end
diff --git a/spree/api/spec/services/spree/api/v3/filters_aggregator_spec.rb b/spree/api/spec/services/spree/api/v3/filters_aggregator_spec.rb
index 26d8cd36d0..acb8228c54 100644
--- a/spree/api/spec/services/spree/api/v3/filters_aggregator_spec.rb
+++ b/spree/api/spec/services/spree/api/v3/filters_aggregator_spec.rb
@@ -93,16 +93,16 @@ RSpec.describe Spree::Api::V3::FiltersAggregator do
expect(size_filter).to be_present
expect(size_filter[:type]).to eq('option')
- expect(size_filter[:presentation]).to eq('Size')
+ expect(size_filter[:label]).to eq('Size')
end
it 'includes option values with counts' do
size_filter = result[:filters].find { |f| f[:name] == 'size' }
options = size_filter[:options]
- expect(options.map { |o| o[:presentation] }).to contain_exactly('S', 'M')
+ expect(options.map { |o| o[:label] }).to contain_exactly('S', 'M')
- s_option = options.find { |o| o[:presentation] == 'S' }
+ s_option = options.find { |o| o[:label] == 'S' }
expect(s_option[:count]).to eq(1)
end
diff --git a/spree/core/app/models/spree/address.rb b/spree/core/app/models/spree/address.rb
index bc2d32bc22..564b2a4bb1 100644
--- a/spree/core/app/models/spree/address.rb
+++ b/spree/core/app/models/spree/address.rb
@@ -83,6 +83,8 @@ module Spree
delegate :abbr, to: :state, prefix: true, allow_nil: true
alias_attribute :postal_code, :zipcode
+ alias_attribute :first_name, :firstname
+ alias_attribute :last_name, :lastname
# Writer methods for API convenience - these set country/state from ISO/abbr codes
# The reader methods (country_iso, state_abbr) are delegates to country.iso and state.abbr
@@ -111,21 +113,7 @@ module Spree
user.present? && id == user.ship_address_id
end
- def first_name
- firstname
- end
-
- def first_name=(value)
- self.firstname = value
- end
-
- def last_name
- lastname
- end
-
- def last_name=(value)
- self.lastname = value
- end
+ # first_name / last_name aliases are defined via alias_attribute above
def full_name
"#{firstname} #{lastname}".strip
diff --git a/spree/core/app/models/spree/cart_promotion.rb b/spree/core/app/models/spree/cart_promotion.rb
deleted file mode 100644
index 8325ab5431..0000000000
--- a/spree/core/app/models/spree/cart_promotion.rb
+++ /dev/null
@@ -1,7 +0,0 @@
-module Spree
- # Cart-facing view of an OrderPromotion.
- # Same table, different prefix ID (cp_) for the Cart API.
- class CartPromotion < OrderPromotion
- has_prefix_id :cpromo
- end
-end
diff --git a/spree/core/app/models/spree/credit_card.rb b/spree/core/app/models/spree/credit_card.rb
index feeab3d808..243355fb65 100644
--- a/spree/core/app/models/spree/credit_card.rb
+++ b/spree/core/app/models/spree/credit_card.rb
@@ -48,6 +48,7 @@ module Spree
scope :not_removed, -> { where(deleted_at: nil) }
alias_attribute :brand, :cc_type
+ alias_attribute :last4, :last_digits
store_accessor :private_metadata, :wallet
diff --git a/spree/core/app/models/spree/line_item.rb b/spree/core/app/models/spree/line_item.rb
index b8e27d5bda..2dcb607e92 100644
--- a/spree/core/app/models/spree/line_item.rb
+++ b/spree/core/app/models/spree/line_item.rb
@@ -102,6 +102,10 @@ module Spree
alias single_money display_price
alias single_display_amount display_price
+ # 5.5 API naming bridges (DB column rename in 6.0)
+ alias_attribute :discount_total, :promo_total
+ alias display_discount_total display_promo_total
+
def discounted_price
return price if quantity.zero?
diff --git a/spree/core/app/models/spree/option_type.rb b/spree/core/app/models/spree/option_type.rb
index d682f01932..07785b60e1 100644
--- a/spree/core/app/models/spree/option_type.rb
+++ b/spree/core/app/models/spree/option_type.rb
@@ -33,6 +33,9 @@ module Spree
has_many :option_type_prototypes, class_name: 'Spree::OptionTypePrototype'
has_many :prototypes, through: :option_type_prototypes, class_name: 'Spree::Prototype'
+ # 5.5 API naming bridge (DB column rename in 6.0)
+ alias_attribute :label, :presentation
+
#
# Validations
#
diff --git a/spree/core/app/models/spree/option_value.rb b/spree/core/app/models/spree/option_value.rb
index 810dacd88d..a2f42593f7 100644
--- a/spree/core/app/models/spree/option_value.rb
+++ b/spree/core/app/models/spree/option_value.rb
@@ -28,6 +28,9 @@ module Spree
has_many :variants, through: :option_value_variants, class_name: 'Spree::Variant'
has_many :products, through: :variants, class_name: 'Spree::Product'
+ # 5.5 API naming bridge (DB column rename in 6.0)
+ alias_attribute :label, :presentation
+
#
# Validations
#
diff --git a/spree/core/app/models/spree/order.rb b/spree/core/app/models/spree/order.rb
index 69020539cb..e57005f6e7 100644
--- a/spree/core/app/models/spree/order.rb
+++ b/spree/core/app/models/spree/order.rb
@@ -54,6 +54,12 @@ module Spree
alias display_ship_total display_shipment_total
alias_attribute :ship_total, :shipment_total
+ # 5.5 API naming bridges (DB columns rename in 6.0)
+ alias_attribute :discount_total, :promo_total
+ alias display_discount_total display_promo_total
+ alias_attribute :customer_note, :special_instructions
+ alias_attribute :total_quantity, :item_count
+
MONEY_THRESHOLD = 100_000_000
MONEY_VALIDATION = {
presence: true,
@@ -108,11 +114,13 @@ module Spree
optional: true, dependent: :destroy
alias_method :billing_address, :bill_address
alias_method :billing_address=, :bill_address=
+ alias_attribute :billing_address_id, :bill_address_id
belongs_to :ship_address, foreign_key: :ship_address_id, class_name: 'Spree::Address',
optional: true, dependent: :destroy
alias_method :shipping_address, :ship_address
alias_method :shipping_address=, :ship_address=
+ alias_attribute :shipping_address_id, :ship_address_id
belongs_to :store, class_name: 'Spree::Store'
@@ -139,7 +147,6 @@ module Spree
inverse_of: :order
has_many :order_promotions, class_name: 'Spree::OrderPromotion'
- has_many :cart_promotions, class_name: 'Spree::CartPromotion', foreign_key: :order_id
has_many :promotions, through: :order_promotions, class_name: 'Spree::Promotion'
has_many :shipments, class_name: 'Spree::Shipment', dependent: :destroy, inverse_of: :order do
@@ -150,10 +157,18 @@ module Spree
has_many :shipment_adjustments, through: :shipments, source: :adjustments
alias items line_items
+ alias discounts order_promotions
+ alias fulfillments shipments
+ alias_attribute :delivery_total, :shipment_total
+ alias display_delivery_total display_shipment_total
+ alias_attribute :fulfillment_status, :shipment_state
+ alias_attribute :payment_status, :payment_state
accepts_nested_attributes_for :line_items
accepts_nested_attributes_for :bill_address
accepts_nested_attributes_for :ship_address
+ alias shipping_address_attributes= ship_address_attributes=
+ alias billing_address_attributes= bill_address_attributes=
accepts_nested_attributes_for :payments, reject_if: :credit_card_nil_payment?
accepts_nested_attributes_for :shipments
diff --git a/spree/core/app/models/spree/order_promotion.rb b/spree/core/app/models/spree/order_promotion.rb
index 1c0a06f79b..317e358294 100644
--- a/spree/core/app/models/spree/order_promotion.rb
+++ b/spree/core/app/models/spree/order_promotion.rb
@@ -1,6 +1,6 @@
module Spree
class OrderPromotion < Spree.base_class
- has_prefix_id :oprom
+ has_prefix_id :discount
belongs_to :order, class_name: 'Spree::Order'
belongs_to :promotion, class_name: 'Spree::Promotion'
diff --git a/spree/core/app/models/spree/search_provider/meilisearch.rb b/spree/core/app/models/spree/search_provider/meilisearch.rb
index 25d6e0d670..7d2cfa8f27 100644
--- a/spree/core/app/models/spree/search_provider/meilisearch.rb
+++ b/spree/core/app/models/spree/search_provider/meilisearch.rb
@@ -242,7 +242,7 @@ module Spree
ot = ov.option_type
by_option_type[ot] ||= []
- by_option_type[ot] << { id: ov.prefixed_id, name: ov.name, presentation: ov.presentation, position: ov.position, count: count }
+ by_option_type[ot] << { id: ov.prefixed_id, name: ov.name, label: ov.label, position: ov.position, count: count }
end
by_option_type.each do |option_type, values|
@@ -250,7 +250,7 @@ module Spree
id: option_type.prefixed_id,
type: 'option',
name: option_type.name,
- presentation: option_type.presentation,
+ label: option_type.label,
options: values.sort_by { |o| o[:position] }
}
end
diff --git a/spree/core/app/models/spree/wishlist.rb b/spree/core/app/models/spree/wishlist.rb
index 2cde08126c..8bf0241c01 100644
--- a/spree/core/app/models/spree/wishlist.rb
+++ b/spree/core/app/models/spree/wishlist.rb
@@ -16,6 +16,7 @@ module Spree
belongs_to :store, class_name: 'Spree::Store'
has_many :wished_items, class_name: 'Spree::WishedItem', dependent: :destroy
+ alias wishlist_items wished_items
has_many :variants, through: :wished_items, source: :variant, class_name: 'Spree::Variant'
has_many :products, -> { distinct }, through: :variants, source: :product, class_name: 'Spree::Product'
diff --git a/spree/core/app/services/spree/carts/update.rb b/spree/core/app/services/spree/carts/update.rb
index aaed081c85..c0504ca620 100644
--- a/spree/core/app/services/spree/carts/update.rb
+++ b/spree/core/app/services/spree/carts/update.rb
@@ -9,8 +9,8 @@ module Spree
ApplicationRecord.transaction do
assign_cart_attributes
- assign_address(:ship_address)
- assign_address(:bill_address)
+ assign_address(:shipping_address)
+ assign_address(:billing_address)
cart.save!
@@ -34,7 +34,7 @@ module Spree
def assign_cart_attributes
cart.email = params[:email] if params[:email].present?
- cart.special_instructions = params[:special_instructions] if params.key?(:special_instructions)
+ cart.customer_note = params[:customer_note] if params.key?(:customer_note)
cart.currency = params[:currency].upcase if params[:currency].present?
cart.locale = params[:locale] if params[:locale].present?
cart.metadata = cart.metadata.merge(params[:metadata].to_h) if params[:metadata].present?
@@ -59,7 +59,7 @@ module Spree
# Only revert to address state when shipping address changes.
# Billing address updates (e.g. during payment) should not
# destroy shipments and reset the checkout flow.
- revert_to_address_state if address_type == :ship_address && cart.has_checkout_step?('address')
+ revert_to_address_state if address_type == :shipping_address && cart.has_checkout_step?('address')
cart.public_send(:"#{address_type}_attributes=", address_params)
end
end
diff --git a/spree/core/spec/services/spree/carts/update_spec.rb b/spree/core/spec/services/spree/carts/update_spec.rb
index 6ad63f3207..baa0832368 100644
--- a/spree/core/spec/services/spree/carts/update_spec.rb
+++ b/spree/core/spec/services/spree/carts/update_spec.rb
@@ -18,25 +18,25 @@ module Spree
end
end
- describe 'updating special_instructions' do
- let(:params) { { special_instructions: 'Leave at the door' } }
+ describe 'updating customer_note' do
+ let(:params) { { customer_note: 'Leave at the door' } }
- it 'updates the special instructions' do
+ it 'updates the customer note' do
expect(subject).to be_success
expect(order.reload.special_instructions).to eq('Leave at the door')
end
- context 'when clearing special_instructions' do
+ context 'when clearing customer_note' do
let(:order) { create(:order_with_line_items, user: user, store: store, special_instructions: 'Existing instructions') }
it 'clears with empty string' do
- result = described_class.call(cart: order, params: { special_instructions: '' })
+ result = described_class.call(cart: order, params: { customer_note: '' })
expect(result).to be_success
expect(order.reload.special_instructions).to eq('')
end
it 'clears with nil' do
- result = described_class.call(cart: order, params: { special_instructions: nil })
+ result = described_class.call(cart: order, params: { customer_note: nil })
expect(result).to be_success
expect(order.reload.special_instructions).to be_nil
end
@@ -85,11 +85,11 @@ module Spree
let(:params) do
{
address_key => {
- firstname: 'John',
- lastname: 'Doe',
+ first_name: 'John',
+ last_name: 'Doe',
address1: '123 Main St',
city: 'New York',
- zipcode: '10001',
+ postal_code: '10001',
country_iso: 'US',
state_abbr: 'NY',
phone: '555-1234'
@@ -100,11 +100,11 @@ module Spree
it 'creates a new address' do
expect(subject).to be_success
address = order.reload.public_send(address_key)
- expect(address.firstname).to eq('John')
- expect(address.lastname).to eq('Doe')
+ expect(address.first_name).to eq('John')
+ expect(address.last_name).to eq('Doe')
expect(address.address1).to eq('123 Main St')
expect(address.city).to eq('New York')
- expect(address.zipcode).to eq('10001')
+ expect(address.postal_code).to eq('10001')
expect(address.country.iso).to eq('US')
expect(address.state.abbr).to eq('NY')
end
@@ -149,12 +149,12 @@ module Spree
end
end
- describe 'ship_address' do
- include_examples 'address update', :ship_address
+ describe 'shipping_address' do
+ include_examples 'address update', :shipping_address
end
- describe 'bill_address' do
- include_examples 'address update', :bill_address
+ describe 'billing_address' do
+ include_examples 'address update', :billing_address
end
end
@@ -165,12 +165,12 @@ module Spree
let(:params) do
{
- bill_address: {
- firstname: 'Jane',
- lastname: 'Doe',
+ billing_address: {
+ first_name: 'Jane',
+ last_name: 'Doe',
address1: '456 Oak Ave',
city: 'New York',
- zipcode: '10002',
+ postal_code: '10002',
country_iso: 'US',
state_abbr: 'NY',
phone: '555-9999'
@@ -220,12 +220,12 @@ module Spree
end
end
- include_examples 'ignores other users address', :ship_address
- include_examples 'ignores other users address', :bill_address
+ include_examples 'ignores other users address', :shipping_address
+ include_examples 'ignores other users address', :billing_address
context 'when order has no user (guest order)' do
let(:order) { create(:order_with_line_items, user: nil, store: store) }
- let(:params) { { ship_address_id: other_users_address.prefixed_id } }
+ let(:params) { { shipping_address_id: other_users_address.prefixed_id } }
it 'ignores address_id params and keeps existing address' do
original_address_id = order.ship_address_id
@@ -262,13 +262,13 @@ module Spree
let(:params) do
{
- special_instructions: 'Handle with care',
- ship_address: {
- firstname: 'John',
- lastname: 'Doe',
+ customer_note: 'Handle with care',
+ shipping_address: {
+ first_name: 'John',
+ last_name: 'Doe',
address1: '123 Main St',
city: 'New York',
- zipcode: '10001',
+ postal_code: '10001',
country_iso: 'US',
state_abbr: 'NY'
}
@@ -279,8 +279,8 @@ module Spree
expect(subject).to be_success
order.reload
expect(order.email).to eq('[email protected]')
- expect(order.special_instructions).to eq('Handle with care')
- expect(order.ship_address.firstname).to eq('John')
+ expect(order.customer_note).to eq('Handle with care')
+ expect(order.shipping_address.first_name).to eq('John')
end
end
@@ -352,7 +352,7 @@ module Spree
describe 'error handling' do
context 'with invalid address prefix_id' do
- let(:params) { { ship_address_id: 'addr_invalid123' } }
+ let(:params) { { shipping_address_id: 'addr_invalid123' } }
it 'succeeds but does not change the address' do
original_address_id = order.ship_address_id