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.

Add support for Store Credits and Gift Cards on cart/checkout (#13814)

Damian Legawiec0390f0e8b17b
diff --git a/docs/api-reference/store.yaml b/docs/api-reference/store.yaml
index 054333f5fc..f38eded7ae 100644
--- a/docs/api-reference/store.yaml
+++ b/docs/api-reference/store.yaml
@@ -590,17 +590,19 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjVkOGQ3NjQ5LTdhYTAtNDllMC1iYmYwLTkyMjI2NDY4MjhlNiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0MjU2MDgzfQ.S5PJ76kgwxWCbESeXfVcTgLsIJQ0ViZplfQtjmSHOso
- refresh_token: ZtBpaDTMrGxejnzG1SFiBbuS
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6ImYwNWZhZGFiLWM2ZGYtNDcyMy05NTdlLTE4MDM4MGE1MjJjYiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0MjYyODEyfQ.WDd_6bKcxBEivJUj00OyLN0UPsQhfXfYoMngY1iMrO4
+ refresh_token: xR2Pt7CKvGCnEkTZEcbr3xpC
user:
id: cus_UkLWZg9DAJ
- first_name: Josephina
- last_name: D'Amore
+ first_name: Antionette
+ last_name: Eichmann
phone:
accepts_email_marketing: false
- created_at: '2026-03-23T07:54:43.096Z'
- updated_at: '2026-03-23T07:54:43.096Z'
+ created_at: '2026-03-23T09:46:52.288Z'
+ updated_at: '2026-03-23T09:46:52.288Z'
+ available_store_credit_total: '0'
+ display_available_store_credit_total: "$0.00"
addresses: []
default_billing_address:
default_shipping_address:
@@ -671,17 +673,19 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjIxOTQ0NDZlLTE4ODYtNDQ2ZC04MWE3LTExMGJmN2ZjM2Q3MSIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0MjU2MDg0fQ.zIFObWzyDdh4ET-ENcYREiTvCOOd6OnafPj9re-zTy4
- refresh_token: QGHhDSsp38ysYhAKbdMwPCWd
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjJjNWQ0MzcwLWRhNTgtNDNiMy1hMThmLTllOGI2MTFmYWQ5MiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0MjYyODEzfQ.o81wrve9qORIApLafz0AJT1Bb8eHYaBv6gjqo_JKnaw
+ refresh_token: rBw6Yx2A225y3ph2YjRmf7SR
user:
id: cus_UkLWZg9DAJ
- first_name: Arvilla
- last_name: Carroll
+ first_name: Donte
+ last_name: Frami
phone:
accepts_email_marketing: false
- created_at: '2026-03-23T07:54:44.587Z'
- updated_at: '2026-03-23T07:54:44.587Z'
+ created_at: '2026-03-23T09:46:53.689Z'
+ updated_at: '2026-03-23T09:46:53.689Z'
+ available_store_credit_total: '0'
+ display_available_store_credit_total: "$0.00"
addresses: []
default_billing_address:
default_shipping_address:
@@ -796,9 +800,9 @@ paths:
example:
data:
- id: cart_gbHJdmfrXB
- number: R114066765
- token: SDcatL6GpwCvJrTv3bdSwZUE2NS9mppCg6F
+ number: R924172813
+ token: EKiCpQJa3wYoyN1jx5wp3cXBUKCryTqnxNT
customer_note:
currency: USD
locale: en
@@ -819,8 +823,13 @@ paths:
display_total: "$110.00"
delivery_total: '100.0'
display_delivery_total: "$100.00"
- created_at: '2026-03-23T07:54:46.845Z'
- updated_at: '2026-03-23T07:54:46.895Z'
+ created_at: '2026-03-23T09:46:55.808Z'
+ updated_at: '2026-03-23T09:46:55.858Z'
+ store_credit_total: '0.0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
current_step: address
completed_steps: []
requirements:
@@ -834,8 +843,8 @@ paths:
variant_id: variant_gbHJdmfrXB
quantity: 1
currency: USD
- name: Product 24432
- slug: product-24432
+ name: Product 21603
+ slug: product-21603
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -854,21 +863,21 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:54:46.875Z'
- updated_at: '2026-03-23T07:54:46.875Z'
+ created_at: '2026-03-23T09:46:55.837Z'
+ updated_at: '2026-03-23T09:46:55.837Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_gbHJdmfrXB
- number: H71755744433
+ number: H09789131868
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-23T07:54:46.882Z'
- updated_at: '2026-03-23T07:54:46.892Z'
+ created_at: '2026-03-23T09:46:55.844Z'
+ updated_at: '2026-03-23T09:46:55.856Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -883,7 +892,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_32
- name: Chantell Hamill
+ name: Celestina Olson
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -941,10 +950,11 @@ paths:
is_default_shipping: false
state_name: STATE_NAME_37
payment_methods: []
+ gift_card:
- id: cart_UkLWZg9DAJ
- number: R188381154
- token: Sj6RDaWE7PFvmrd2XMP4Sk3Gzk6chM4wDY3
+ number: R025508041
+ token: wYaCkVMobq3zaK93hAPc54ecudtmKDHrjfr
customer_note:
currency: USD
locale: en
@@ -965,8 +975,13 @@ paths:
display_total: "$110.00"
delivery_total: '100.0'
display_delivery_total: "$100.00"
- created_at: '2026-03-23T07:54:46.686Z'
- updated_at: '2026-03-23T07:54:46.839Z'
+ created_at: '2026-03-23T09:46:55.645Z'
+ updated_at: '2026-03-23T09:46:55.802Z'
+ store_credit_total: '0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
current_step: address
completed_steps: []
requirements:
@@ -980,8 +995,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 17692
- slug: product-17692
+ name: Product 11471
+ slug: product-11471
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1000,21 +1015,21 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:54:46.764Z'
- updated_at: '2026-03-23T07:54:46.764Z'
+ created_at: '2026-03-23T09:46:55.721Z'
+ updated_at: '2026-03-23T09:46:55.721Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H16073350442
+ number: H77816392993
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-23T07:54:46.778Z'
- updated_at: '2026-03-23T07:54:46.835Z'
+ created_at: '2026-03-23T09:46:55.736Z'
+ updated_at: '2026-03-23T09:46:55.796Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -1029,7 +1044,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_32
- name: Chantell Hamill
+ name: Celestina Olson
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1087,6 +1102,7 @@ paths:
is_default_shipping: false
state_name: STATE_NAME_35
payment_methods: []
+ gift_card:
meta:
page: 1
limit: 25
@@ -1161,8 +1177,8 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R434559223
- token: yjzjHZpoJZLfcvSaoWwcXgaQWLw9raNRmTm
+ number: R716592162
+ token: 2zQSF1vyMJHi9Mot1fuyyUhMjLJ9h1RrFX5
email:
customer_note:
currency: USD
@@ -1184,8 +1200,13 @@ paths:
display_total: "$0.00"
delivery_total: '0.0'
display_delivery_total: "$0.00"
- created_at: '2026-03-23T07:54:47.392Z'
- updated_at: '2026-03-23T07:54:47.392Z'
+ created_at: '2026-03-23T09:46:56.362Z'
+ updated_at: '2026-03-23T09:46:56.362Z'
+ store_credit_total: '0.0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
current_step: address
completed_steps: []
requirements:
@@ -1209,6 +1230,7 @@ paths:
billing_address:
shipping_address:
payment_methods: []
+ gift_card:
schema:
"$ref": "#/components/schemas/Cart"
requestBody:
@@ -1293,9 +1315,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R361822387
- token: BPCDVqzhdM6y1gmX6wFKVF43ZvTfwcpoVyK
+ number: R268304368
+ token: En7wj5qcxESv3EebCmYdjhnui8Pov9vBSmL
customer_note:
currency: USD
locale: en
@@ -1316,8 +1338,13 @@ paths:
display_total: "$110.00"
delivery_total: '100.0'
display_delivery_total: "$100.00"
- created_at: '2026-03-23T07:54:47.676Z'
- updated_at: '2026-03-23T07:54:47.745Z'
+ created_at: '2026-03-23T09:46:56.650Z'
+ updated_at: '2026-03-23T09:46:56.708Z'
+ store_credit_total: '0.0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
current_step: address
completed_steps: []
requirements:
@@ -1331,8 +1358,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 53056
- slug: product-53056
+ name: Product 57741
+ slug: product-57741
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1351,21 +1378,21 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:54:47.716Z'
- updated_at: '2026-03-23T07:54:47.716Z'
+ created_at: '2026-03-23T09:46:56.684Z'
+ updated_at: '2026-03-23T09:46:56.684Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H51321009697
+ number: H52062195535
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-23T07:54:47.722Z'
- updated_at: '2026-03-23T07:54:47.742Z'
+ created_at: '2026-03-23T09:46:56.689Z'
+ updated_at: '2026-03-23T09:46:56.705Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -1380,7 +1407,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_42
- name: Lavon Ebert
+ name: Terri Kilback
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1438,6 +1465,7 @@ paths:
is_default_shipping: false
state_name: STATE_NAME_43
payment_methods: []
+ gift_card:
schema:
"$ref": "#/components/schemas/Cart"
'404':
@@ -1518,9 +1546,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R545718829
- token: RyAB3Xuf8CGmHDTtbJuLXHBMUi92eWm13Ds
+ number: R643287117
+ token: 5cUFxrcXZRdYJD6Tbz2yEUBcEaK9utgxwNz
customer_note: Leave at door
currency: USD
locale: en
@@ -1541,8 +1569,13 @@ paths:
display_total: "$29.99"
delivery_total: '10.0'
display_delivery_total: "$10.00"
- created_at: '2026-03-23T07:54:48.336Z'
- updated_at: '2026-03-23T07:54:48.470Z'
+ created_at: '2026-03-23T09:46:57.310Z'
+ updated_at: '2026-03-23T09:46:57.460Z'
+ store_credit_total: '0.0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
current_step: payment
completed_steps:
- address
@@ -1558,8 +1591,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 61723
- slug: product-61723
+ name: Product 69059
+ slug: product-69059
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -1578,21 +1611,21 @@ paths:
discounted_amount: '19.99'
display_discounted_amount: "$19.99"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:54:48.366Z'
- updated_at: '2026-03-23T07:54:48.423Z'
+ created_at: '2026-03-23T09:46:57.348Z'
+ updated_at: '2026-03-23T09:46:57.413Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_gbHJdmfrXB
- number: H34471054639
+ number: H86727849517
tracking:
tracking_url:
cost: '10.0'
display_cost: "$10.00"
- created_at: '2026-03-23T07:54:48.440Z'
- updated_at: '2026-03-23T07:54:48.455Z'
+ created_at: '2026-03-23T09:46:57.432Z'
+ updated_at: '2026-03-23T09:46:57.445Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -1607,7 +1640,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_44
- name: Emmanuel Hansen
+ name: Phyliss Okuneva
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1665,6 +1698,7 @@ paths:
is_default_shipping: false
state_name: STATE_NAME_47
payment_methods: []
+ gift_card:
schema:
"$ref": "#/components/schemas/Cart"
requestBody:
@@ -1833,9 +1867,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R743483033
- token: 58WPfsbmnN7n75vzPfBHBtWUN9eWVpJg7sF
+ number: R060374466
+ token: TbWX5EuG5xhXpGsCNeiwaLDJihBXpQoQBPR
customer_note:
currency: USD
locale: en
@@ -1856,8 +1890,13 @@ paths:
display_total: "$110.00"
delivery_total: '100.0'
display_delivery_total: "$100.00"
- created_at: '2026-03-23T07:54:49.145Z'
- updated_at: '2026-03-23T07:54:49.203Z'
+ created_at: '2026-03-23T09:46:58.142Z'
+ updated_at: '2026-03-23T09:46:58.231Z'
+ store_credit_total: '0.0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
current_step: address
completed_steps: []
requirements:
@@ -1871,8 +1910,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 87429
- slug: product-87429
+ name: Product 83358
+ slug: product-83358
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1891,21 +1930,21 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:54:49.176Z'
- updated_at: '2026-03-23T07:54:49.176Z'
+ created_at: '2026-03-23T09:46:58.186Z'
+ updated_at: '2026-03-23T09:46:58.186Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H81954662688
+ number: H21726362583
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-23T07:54:49.182Z'
- updated_at: '2026-03-23T07:54:49.198Z'
+ created_at: '2026-03-23T09:46:58.197Z'
+ updated_at: '2026-03-23T09:46:58.226Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -1920,7 +1959,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_52
- name: Calvin Abshire
+ name: Hubert Padberg
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1978,6 +2017,7 @@ paths:
is_default_shipping: false
state_name: STATE_NAME_53
payment_methods: []
+ gift_card:
schema:
"$ref": "#/components/schemas/Cart"
'401':
@@ -2043,8 +2083,8 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R603783969
+ number: R404139967
customer_note:
currency: USD
locale: en
@@ -2067,17 +2107,22 @@ paths:
display_delivery_total: "$10.00"
fulfillment_status: backorder
payment_status: paid
- completed_at: '2026-03-23T07:54:50.666Z'
- created_at: '2026-03-23T07:54:50.436Z'
- updated_at: '2026-03-23T07:54:50.666Z'
+ completed_at: '2026-03-23T09:46:59.646Z'
+ created_at: '2026-03-23T09:46:59.438Z'
+ updated_at: '2026-03-23T09:46:59.646Z'
+ store_credit_total: '0.0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 102735
- slug: product-102735
+ name: Product 105172
+ slug: product-105172
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -2096,21 +2141,21 @@ paths:
discounted_amount: '19.99'
display_discounted_amount: "$19.99"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:54:50.467Z'
- updated_at: '2026-03-23T07:54:50.669Z'
+ created_at: '2026-03-23T09:46:59.466Z'
+ updated_at: '2026-03-23T09:46:59.650Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_gbHJdmfrXB
- number: H60905879469
+ number: H64614779788
tracking:
tracking_url:
cost: '10.0'
display_cost: "$10.00"
- created_at: '2026-03-23T07:54:50.537Z'
- updated_at: '2026-03-23T07:54:50.659Z'
+ created_at: '2026-03-23T09:46:59.529Z'
+ updated_at: '2026-03-23T09:46:59.640Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -2125,7 +2170,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_58
- name: Linnie Dietrich
+ name: Salena Stamm
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -2147,11 +2192,11 @@ paths:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
response_code: '12345'
- number: PBKZPCYO
+ number: P9RIMUKW
amount: '29.99'
display_amount: "$29.99"
- created_at: '2026-03-23T07:54:50.609Z'
- updated_at: '2026-03-23T07:54:50.640Z'
+ created_at: '2026-03-23T09:46:59.598Z'
+ updated_at: '2026-03-23T09:46:59.622Z'
status: completed
source_type: credit_card
source_id: card_UkLWZg9DAJ
@@ -2208,6 +2253,7 @@ paths:
is_default_billing: false
is_default_shipping: false
state_name: STATE_NAME_61
+ gift_card:
schema:
"$ref": "#/components/schemas/Order"
'422':
@@ -2288,8 +2334,8 @@ paths:
meta_description:
meta_keywords:
children_count: 1
- created_at: '2026-03-23T07:54:51.321Z'
- updated_at: '2026-03-23T07:54:51.377Z'
+ created_at: '2026-03-23T09:47:00.287Z'
+ updated_at: '2026-03-23T09:47:00.352Z'
parent_id:
description: ''
description_html: ''
@@ -2307,8 +2353,8 @@ paths:
meta_description:
meta_keywords:
children_count: 1
- created_at: '2026-03-23T07:54:51.329Z'
- updated_at: '2026-03-23T07:54:51.377Z'
+ created_at: '2026-03-23T09:47:00.294Z'
+ updated_at: '2026-03-23T09:47:00.351Z'
parent_id: ctg_UkLWZg9DAJ
description: ''
description_html: ''
@@ -2326,8 +2372,8 @@ paths:
meta_description:
meta_keywords:
children_count: 0
- created_at: '2026-03-23T07:54:51.337Z'
- updated_at: '2026-03-23T07:54:51.342Z'
+ created_at: '2026-03-23T09:47:00.305Z'
+ updated_at: '2026-03-23T09:47:00.320Z'
parent_id: ctg_gbHJdmfrXB
description: ''
description_html: ''
@@ -2428,8 +2474,8 @@ paths:
meta_description:
meta_keywords:
children_count: 1
- created_at: '2026-03-23T07:54:51.708Z'
- updated_at: '2026-03-23T07:54:51.748Z'
+ created_at: '2026-03-23T09:47:00.679Z'
+ updated_at: '2026-03-23T09:47:00.714Z'
parent_id: ctg_UkLWZg9DAJ
description: ''
description_html: ''
@@ -2556,29 +2602,28 @@ paths:
example:
data:
- id: prod_UkLWZg9DAJ
- name: Product 198042
- slug: product-198042
+ name: Product 192296
+ slug: product-192296
meta_description:
meta_keywords:
variant_count: 0
- available_on: '2025-03-23T07:54:52.220Z'
- created_at: '2026-03-23T07:54:52.235Z'
- updated_at: '2026-03-23T07:54:52.251Z'
+ available_on: '2025-03-23T09:47:01.180Z'
+ created_at: '2026-03-23T09:47:01.195Z'
+ updated_at: '2026-03-23T09:47:01.209Z'
purchasable: true
in_stock: false
backorderable: true
available: true
- description: Incidunt sequi voluptas assumenda sapiente temporibus
- consequatur voluptatum architecto. Occaecati quod neque assumenda
- magni vel tenetur. Aliquam fugit voluptate quibusdam magni ullam
- est illo. Quas error atque at quaerat repudiandae. Voluptates
- vel molestiae corrupti enim sapiente expedita aliquid id. Natus
- numquam a repellendus quos reiciendis enim. Nostrum quos qui iste
- sapiente magni veniam recusandae nobis. Unde at cumque facere
- sunt alias maiores numquam.
+ description: Iure sequi deleniti quod illum quae. Vel perspiciatis
+ nobis aspernatur quae vitae quisquam officia. Aliquam non cupiditate
+ delectus cum. Provident debitis laborum illum consectetur ad aut
+ ducimus. Id repellendus repellat aliquid rerum necessitatibus
+ quae. Optio tempore quae itaque est perspiciatis illum tempora.
+ Aspernatur asperiores temporibus odit nostrum. Ipsam esse distinctio
+ reprehenderit perferendis laborum.
description_html: |-
- Incidunt sequi voluptas assumenda sapiente temporibus consequatur voluptatum architecto. Occaecati quod neque assumenda magni vel tenetur. Aliquam fugit voluptate quibusdam magni ullam est illo. Quas error atque at quaerat repudiandae. Voluptates vel molestiae corrupti enim sapiente expedita aliquid id.
- Natus numquam a repellendus quos reiciendis enim. Nostrum quos qui iste sapiente magni veniam recusandae nobis. Unde at cumque facere sunt alias maiores numquam.
+ Iure sequi deleniti quod illum quae. Vel perspiciatis nobis aspernatur quae vitae quisquam officia. Aliquam non cupiditate delectus cum.
+ Provident debitis laborum illum consectetur ad aut ducimus. Id repellendus repellat aliquid rerum necessitatibus quae. Optio tempore quae itaque est perspiciatis illum tempora. Aspernatur asperiores temporibus odit nostrum. Ipsam esse distinctio reprehenderit perferendis laborum.
default_variant_id: variant_UkLWZg9DAJ
thumbnail_url:
tags: []
@@ -2844,9 +2889,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R326400578
- token: 4JVz36SLLMbNR5z8WZwhR7YNKKDXQgKmrpt
+ number: R004874374
+ token: uHE4ndiN88j6CekZ1323ESQAwFS5zeNk346
customer_note:
currency: USD
locale: en
@@ -2867,8 +2912,13 @@ paths:
display_total: "$110.00"
delivery_total: '100.0'
display_delivery_total: "$100.00"
- created_at: '2026-03-23T07:54:54.090Z'
- updated_at: '2026-03-23T07:54:54.201Z'
+ created_at: '2026-03-23T09:47:02.958Z'
+ updated_at: '2026-03-23T09:47:03.078Z'
+ store_credit_total: '50.0'
+ display_store_credit_total: "-$50.00"
+ gift_card_total: '50.0'
+ display_gift_card_total: "$50.00"
+ covered_by_store_credit: false
current_step: address
completed_steps: []
requirements: []
@@ -2879,8 +2929,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 233383
- slug: product-233383
+ name: Product 235612
+ slug: product-235612
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -2899,21 +2949,21 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:54:54.126Z'
- updated_at: '2026-03-23T07:54:54.126Z'
+ created_at: '2026-03-23T09:47:02.996Z'
+ updated_at: '2026-03-23T09:47:02.996Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H74687532176
+ number: H19829172400
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-23T07:54:54.133Z'
- updated_at: '2026-03-23T07:54:54.147Z'
+ created_at: '2026-03-23T09:47:03.005Z'
+ updated_at: '2026-03-23T09:47:03.020Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -2928,7 +2978,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_80
- name: Shonta Hammes
+ name: Delisa Hand
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -2949,12 +2999,12 @@ paths:
payments:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- response_code: 1-SC-20260323075454194079
- number: PXJRM75X
+ response_code: 1-SC-20260323094703071904
+ number: P4R01X8M
amount: '50.0'
display_amount: "$50.00"
- created_at: '2026-03-23T07:54:54.195Z'
- updated_at: '2026-03-23T07:54:54.195Z'
+ created_at: '2026-03-23T09:47:03.073Z'
+ updated_at: '2026-03-23T09:47:03.073Z'
status: checkout
source_type: store_credit
source_id: credit_UkLWZg9DAJ
@@ -3017,6 +3067,24 @@ paths:
description:
type: Spree::PaymentMethod::StoreCredit
session_required: false
+ gift_card:
+ id: gc_UkLWZg9DAJ
+ code: GIFTCODE1
+ status: active
+ currency: USD
+ amount: '50.0'
+ amount_used: '50.0'
+ amount_authorized: '0.0'
+ amount_remaining: '0.0'
+ display_amount: "$50.00"
+ display_amount_used: "$50.00"
+ display_amount_remaining: "$0.00"
+ expires_at:
+ redeemed_at:
+ expired: false
+ active: true
+ created_at: '2026-03-23T09:47:03.027Z'
+ updated_at: '2026-03-23T09:47:03.068Z'
schema:
"$ref": "#/components/schemas/Cart"
'422':
@@ -3102,9 +3170,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R171785123
- token: SRij6Tqm9dqzY3tvGHYrqtR5mnNdEwThSyC
+ number: R431828620
+ token: 2DJzZrUcqAGGVwYmsx7bJLLe21NedoVcvtE
customer_note:
currency: USD
locale: en
@@ -3125,8 +3193,13 @@ paths:
display_total: "$110.00"
delivery_total: '100.0'
display_delivery_total: "$100.00"
- created_at: '2026-03-23T07:54:55.375Z'
- updated_at: '2026-03-23T07:54:55.485Z'
+ created_at: '2026-03-23T09:47:04.248Z'
+ updated_at: '2026-03-23T09:47:04.355Z'
+ store_credit_total: '0.0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
current_step: address
completed_steps: []
requirements:
@@ -3140,8 +3213,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 252739
- slug: product-252739
+ name: Product 25249
+ slug: product-25249
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -3160,21 +3233,21 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:54:55.406Z'
- updated_at: '2026-03-23T07:54:55.481Z'
+ created_at: '2026-03-23T09:47:04.277Z'
+ updated_at: '2026-03-23T09:47:04.351Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H29940306403
+ number: H67717632378
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-23T07:54:55.412Z'
- updated_at: '2026-03-23T07:54:55.425Z'
+ created_at: '2026-03-23T09:47:04.283Z'
+ updated_at: '2026-03-23T09:47:04.297Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -3189,7 +3262,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_88
- name: Reina Yundt
+ name: Tyesha Rolfson
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -3247,6 +3320,7 @@ paths:
is_default_shipping: false
state_name: STATE_NAME_91
payment_methods: []
+ gift_card:
schema:
"$ref": "#/components/schemas/Cart"
'422':
@@ -3659,17 +3733,19 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjhiOWMzNmM2LTY2ODYtNDI3YS1hYTE2LWEzM2E0N2YyNzdkZSIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0MjU2MTAwfQ.jMZYOyOyezQTI5j_kqWdDPzSCxnyxZRm70lRcldNVoI
- refresh_token: fkAaHcPSPWDVs38JsZgcvsaK
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjE2MTA1ODU1LWJjMzgtNDI5NC04N2NhLWEyZTMyNTQ2MzNiNyIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0MjYyODI5fQ.NWQMxgKBnCAOZFzRoBJvekMRaojc55DClkhFsIRN5sI
+ refresh_token: urfnTtVfZwYi7ETFdTZGqRsQ
user:
id: cus_UkLWZg9DAJ
- first_name: Joana
- last_name: Muller
+ first_name: Dawn
+ last_name: Goyette
phone:
accepts_email_marketing: false
- created_at: '2026-03-23T07:55:00.370Z'
- updated_at: '2026-03-23T07:55:00.643Z'
+ created_at: '2026-03-23T09:47:09.182Z'
+ updated_at: '2026-03-23T09:47:09.456Z'
+ available_store_credit_total: '0'
+ display_available_store_credit_total: "$0.00"
addresses: []
default_billing_address:
default_shipping_address:
@@ -3757,8 +3833,8 @@ paths:
example:
data:
- id: or_UkLWZg9DAJ
- number: R607022205
+ number: R254770538
customer_note:
currency: USD
locale: en
@@ -3781,17 +3857,22 @@ paths:
display_delivery_total: "$100.00"
fulfillment_status:
payment_status:
- completed_at: '2026-03-23T07:55:01.562Z'
- created_at: '2026-03-23T07:55:01.504Z'
- updated_at: '2026-03-23T07:55:01.562Z'
+ completed_at: '2026-03-23T09:47:10.365Z'
+ created_at: '2026-03-23T09:47:10.313Z'
+ updated_at: '2026-03-23T09:47:10.364Z'
+ store_credit_total: '0.0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 27490
- slug: product-27490
+ name: Product 276107
+ slug: product-276107
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -3810,21 +3891,21 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:55:01.538Z'
- updated_at: '2026-03-23T07:55:01.538Z'
+ created_at: '2026-03-23T09:47:10.345Z'
+ updated_at: '2026-03-23T09:47:10.345Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H13717829048
+ number: H26667211935
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-23T07:55:01.544Z'
- updated_at: '2026-03-23T07:55:01.559Z'
+ created_at: '2026-03-23T09:47:10.350Z'
+ updated_at: '2026-03-23T09:47:10.362Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -3839,7 +3920,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_108
- name: Celine Bins
+ name: Brenton Spencer
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -3896,6 +3977,7 @@ paths:
is_default_billing: false
is_default_shipping: false
state_name: STATE_NAME_111
+ gift_card:
meta:
page: 1
limit: 25
@@ -3963,8 +4045,8 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R196025696
+ number: R606321455
customer_note:
currency: USD
locale: en
@@ -3987,17 +4069,22 @@ paths:
display_delivery_total: "$100.00"
fulfillment_status:
payment_status:
- completed_at: '2026-03-23T07:55:02.255Z'
- created_at: '2026-03-23T07:55:02.200Z'
- updated_at: '2026-03-23T07:55:02.255Z'
+ completed_at: '2026-03-23T09:47:11.085Z'
+ created_at: '2026-03-23T09:47:10.994Z'
+ updated_at: '2026-03-23T09:47:11.084Z'
+ store_credit_total: '0.0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 291248
- slug: product-291248
+ name: Product 293841
+ slug: product-293841
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -4016,21 +4103,21 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:55:02.232Z'
- updated_at: '2026-03-23T07:55:02.232Z'
+ created_at: '2026-03-23T09:47:11.021Z'
+ updated_at: '2026-03-23T09:47:11.021Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H85505698303
+ number: H61254393961
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-23T07:55:02.237Z'
- updated_at: '2026-03-23T07:55:02.252Z'
+ created_at: '2026-03-23T09:47:11.026Z'
+ updated_at: '2026-03-23T09:47:11.081Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -4045,7 +4132,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_114
- name: Mikel O'Hara
+ name: Norma Dach
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -4102,6 +4189,7 @@ paths:
is_default_billing: false
is_default_shipping: false
state_name: STATE_NAME_117
+ gift_card:
schema:
"$ref": "#/components/schemas/Order"
'404':
@@ -4155,8 +4243,8 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjAzZDI0NzY5LWM0OTMtNDdjNS05OWY3LTdkMDdhYWQzOWYxNCIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0MjU2MTAzfQ.-wEuIDw4q3ZX7arLkiCuXiG2ew4nNfRTSy0FhbKgW9k
- refresh_token: uNByoAUZP2JYtMBKk92LqaKX
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6ImZjNjQyYWIzLTM1MmMtNGQwNS1hYjM3LTA5ODgxM2Q0NWFhNSIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0MjYyODMyfQ.JMgjcFXf4F_RXAn7G-vXS1fo59Lx5-Yi7WxyF6EoOXA
+ refresh_token: RGZzmJcRg6u8BShiiAP1cJnF
user:
id: cus_UkLWZg9DAJ
@@ -4164,8 +4252,10 @@ paths:
last_name: Doe
phone: "+1234567890"
accepts_email_marketing: true
- created_at: '2026-03-23T07:55:03.460Z'
- updated_at: '2026-03-23T07:55:03.460Z'
+ created_at: '2026-03-23T09:47:12.285Z'
+ updated_at: '2026-03-23T09:47:12.285Z'
+ available_store_credit_total: '0'
+ display_available_store_credit_total: "$0.00"
addresses: []
default_billing_address:
default_shipping_address:
@@ -4269,13 +4359,15 @@ paths:
application/json:
example:
id: cus_UkLWZg9DAJ
- first_name: Bea
- last_name: Koch
+ first_name: Vannessa
+ last_name: Crona
phone: 555-555-0199
accepts_email_marketing: false
- created_at: '2026-03-23T07:55:04.010Z'
- updated_at: '2026-03-23T07:55:04.281Z'
+ created_at: '2026-03-23T09:47:12.839Z'
+ updated_at: '2026-03-23T09:47:13.107Z'
+ available_store_credit_total: '0'
+ display_available_store_credit_total: "$0.00"
addresses:
- id: addr_gbHJdmfrXB
first_name: John
@@ -4407,13 +4499,15 @@ 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-23T07:55:04.571Z'
- updated_at: '2026-03-23T07:55:04.852Z'
+ created_at: '2026-03-23T09:47:13.405Z'
+ updated_at: '2026-03-23T09:47:13.684Z'
+ available_store_credit_total: '0'
+ display_available_store_credit_total: "$0.00"
addresses:
- id: addr_gbHJdmfrXB
first_name: John
@@ -4648,9 +4742,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R332262450
- token: PhkeL2r1rhDbnpRQZtPERzvWRwGuqraidgm
+ number: R444840980
+ token: rL7tn53w1EaUofuk5W9hhB5NVToiSE31GQX
customer_note:
currency: USD
locale: en
@@ -4671,8 +4765,13 @@ paths:
display_total: "$110.00"
delivery_total: '100.0'
display_delivery_total: "$100.00"
- created_at: '2026-03-23T07:55:08.008Z'
- updated_at: '2026-03-23T07:55:08.096Z'
+ created_at: '2026-03-23T09:47:16.750Z'
+ updated_at: '2026-03-23T09:47:16.844Z'
+ store_credit_total: '0.0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
current_step: payment
completed_steps:
- address
@@ -4688,8 +4787,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 37514
- slug: product-37514
+ name: Product 377282
+ slug: product-377282
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -4708,21 +4807,21 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:55:08.037Z'
- updated_at: '2026-03-23T07:55:08.037Z'
+ created_at: '2026-03-23T09:47:16.784Z'
+ updated_at: '2026-03-23T09:47:16.784Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H43801837402
+ number: H46622685174
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-23T07:55:08.043Z'
- updated_at: '2026-03-23T07:55:08.079Z'
+ created_at: '2026-03-23T09:47:16.789Z'
+ updated_at: '2026-03-23T09:47:16.828Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -4737,7 +4836,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_140
- name: Anissa Wolff
+ name: Marissa Rath
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -4795,6 +4894,7 @@ paths:
is_default_shipping: false
state_name: STATE_NAME_143
payment_methods: []
+ gift_card:
schema:
"$ref": "#/components/schemas/Cart"
'404':
@@ -4878,7 +4978,7 @@ paths:
example:
data:
- id: gc_UkLWZg9DAJ
- code: 21E2305AE12CF568
+ code: 98DA85C8DB495316
status: active
currency: USD
amount: '10.0'
@@ -4892,8 +4992,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-03-23T07:55:09.274Z'
- updated_at: '2026-03-23T07:55:09.274Z'
+ created_at: '2026-03-23T09:47:18.008Z'
+ updated_at: '2026-03-23T09:47:18.008Z'
meta:
page: 1
limit: 25
@@ -4976,7 +5076,7 @@ paths:
application/json:
example:
id: gc_UkLWZg9DAJ
- code: 34373980B6C3543E
+ code: 57D176FBE4A32D55
status: active
currency: USD
amount: '10.0'
@@ -4990,8 +5090,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-03-23T07:55:10.379Z'
- updated_at: '2026-03-23T07:55:10.379Z'
+ created_at: '2026-03-23T09:47:19.103Z'
+ updated_at: '2026-03-23T09:47:19.103Z'
schema:
"$ref": "#/components/schemas/GiftCard"
'404':
@@ -5068,9 +5168,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R210549326
- token: Mb3irhx6orAYQU2YLVy2sgC1Jr5efmPU4JC
+ number: R463847027
+ token: JKifDG2NJvTEspfKeY4Fer1tebB7ujYBjXa
customer_note:
currency: USD
locale: en
@@ -5091,8 +5191,13 @@ paths:
display_total: "$29.99"
delivery_total: '0.0'
display_delivery_total: "$0.00"
- created_at: '2026-03-23T07:55:12.129Z'
- updated_at: '2026-03-23T07:55:12.291Z'
+ created_at: '2026-03-23T09:47:20.884Z'
+ updated_at: '2026-03-23T09:47:20.976Z'
+ store_credit_total: '0.0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
current_step: address
completed_steps: []
requirements:
@@ -5112,8 +5217,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 411957
- slug: product-411957
+ name: Product 413923
+ slug: product-413923
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -5132,8 +5237,8 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:55:12.166Z'
- updated_at: '2026-03-23T07:55:12.166Z'
+ created_at: '2026-03-23T09:47:20.913Z'
+ updated_at: '2026-03-23T09:47:20.913Z'
compare_at_amount:
thumbnail_url:
option_values: []
@@ -5142,8 +5247,8 @@ paths:
variant_id: variant_gbHJdmfrXB
quantity: 1
currency: USD
- name: Product 426023
- slug: product-426023
+ name: Product 424356
+ slug: product-424356
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -5162,8 +5267,8 @@ paths:
discounted_amount: '19.99'
display_discounted_amount: "$19.99"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:55:12.247Z'
- updated_at: '2026-03-23T07:55:12.247Z'
+ created_at: '2026-03-23T09:47:20.953Z'
+ updated_at: '2026-03-23T09:47:20.953Z'
compare_at_amount:
thumbnail_url:
option_values: []
@@ -5191,6 +5296,7 @@ paths:
state_name: STATE_NAME_161
shipping_address:
payment_methods: []
+ gift_card:
schema:
"$ref": "#/components/schemas/Cart"
'404':
@@ -5285,9 +5391,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R498988730
- token: Ltgvva3sDtKZcc18SJXpi5oEbnRbK1EDAoY
+ number: R147829283
+ token: tx28arHAUqPamcnvuSsd1umbp5rqm2QLjb4
customer_note:
currency: USD
locale: en
@@ -5308,8 +5414,13 @@ paths:
display_total: "$0.00"
delivery_total: '0.0'
display_delivery_total: "$0.00"
- created_at: '2026-03-23T07:55:14.083Z'
- updated_at: '2026-03-23T07:55:14.115Z'
+ created_at: '2026-03-23T09:47:22.737Z'
+ updated_at: '2026-03-23T09:47:22.767Z'
+ store_credit_total: '0.0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
current_step: address
completed_steps: []
requirements:
@@ -5326,8 +5437,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 45841
- slug: product-45841
+ name: Product 452092
+ slug: product-452092
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -5346,8 +5457,8 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:55:14.114Z'
- updated_at: '2026-03-23T07:55:14.130Z'
+ created_at: '2026-03-23T09:47:22.766Z'
+ updated_at: '2026-03-23T09:47:22.785Z'
compare_at_amount:
thumbnail_url:
option_values: []
@@ -5375,6 +5486,7 @@ paths:
state_name: STATE_NAME_170
shipping_address:
payment_methods: []
+ gift_card:
schema:
"$ref": "#/components/schemas/Cart"
requestBody:
@@ -5449,9 +5561,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R421684236
- token: drCEijsnA2Xfb8CPNpcDMZhBbkm5HD7aSnA
+ number: R745050318
+ token: 5KWHoMmKxnJWXqcRunWkgTYwweX9m1QRdyt
customer_note:
currency: USD
locale: en
@@ -5472,8 +5584,13 @@ paths:
display_total: "$0.00"
delivery_total: '0.0'
display_delivery_total: "$0.00"
- created_at: '2026-03-23T07:55:14.683Z'
- updated_at: '2026-03-23T07:55:14.735Z'
+ created_at: '2026-03-23T09:47:23.331Z'
+ updated_at: '2026-03-23T09:47:23.380Z'
+ store_credit_total: '0.0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
current_step: address
completed_steps: []
requirements:
@@ -5512,6 +5629,7 @@ paths:
state_name: STATE_NAME_173
shipping_address:
payment_methods: []
+ gift_card:
schema:
"$ref": "#/components/schemas/Cart"
'404':
@@ -6028,7 +6146,7 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R842607622
+ number: R250122845
customer_note:
currency: USD
@@ -6052,17 +6170,22 @@ paths:
display_delivery_total: "$100.00"
fulfillment_status:
payment_status:
- completed_at: '2026-03-23T07:55:16.469Z'
- created_at: '2026-03-23T07:55:16.404Z'
- updated_at: '2026-03-23T07:55:16.469Z'
+ completed_at: '2026-03-23T09:47:25.170Z'
+ created_at: '2026-03-23T09:47:25.119Z'
+ updated_at: '2026-03-23T09:47:25.169Z'
+ store_credit_total: '0.0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
discounts: []
items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 496677
- slug: product-496677
+ name: Product 494345
+ slug: product-494345
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -6081,21 +6204,21 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:55:16.440Z'
- updated_at: '2026-03-23T07:55:16.440Z'
+ created_at: '2026-03-23T09:47:25.149Z'
+ updated_at: '2026-03-23T09:47:25.149Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H67269020522
+ number: H51462799105
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-23T07:55:16.447Z'
- updated_at: '2026-03-23T07:55:16.463Z'
+ created_at: '2026-03-23T09:47:25.154Z'
+ updated_at: '2026-03-23T09:47:25.167Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -6110,7 +6233,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_181
- name: Cleo Weimann
+ name: Vanessa Lesch
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -6167,6 +6290,7 @@ paths:
is_default_billing: false
is_default_shipping: false
state_name: STATE_NAME_182
+ gift_card:
schema:
"$ref": "#/components/schemas/Order"
'404':
@@ -6245,13 +6369,13 @@ paths:
id: ps_gbHJdmfrXB
status: pending
currency: USD
- external_id: bogus_c65264d1899ab86b3f170bd2
+ external_id: bogus_e00ccbc044e5e86289394e0b
external_data:
- client_secret: bogus_secret_8c111c414eb6cd5d
+ client_secret: bogus_secret_e8e38c0d137eae1f
customer_external_id:
expires_at:
- created_at: '2026-03-23T07:55:18.293Z'
- updated_at: '2026-03-23T07:55:18.293Z'
+ created_at: '2026-03-23T09:47:26.976Z'
+ updated_at: '2026-03-23T09:47:26.976Z'
amount: '110.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -6346,13 +6470,13 @@ paths:
id: ps_UkLWZg9DAJ
status: pending
currency: USD
- external_id: bogus_0ec882834cdc60e4df3e3421
+ external_id: bogus_74db71a772f1832dacb652c7
external_data:
client_secret: secret_123
customer_external_id:
expires_at:
- created_at: '2026-03-23T07:55:18.900Z'
- updated_at: '2026-03-23T07:55:18.900Z'
+ created_at: '2026-03-23T09:47:27.576Z'
+ updated_at: '2026-03-23T09:47:27.576Z'
amount: '110.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -6409,13 +6533,13 @@ paths:
id: ps_UkLWZg9DAJ
status: pending
currency: USD
- external_id: bogus_aa43862bb8d8c14aeb52e16d
+ external_id: bogus_905ffa9d1f4fc50b54d8dc63
external_data:
client_secret: secret_123
customer_external_id:
expires_at:
- created_at: '2026-03-23T07:55:20.225Z'
- updated_at: '2026-03-23T07:55:20.239Z'
+ created_at: '2026-03-23T09:47:28.787Z'
+ updated_at: '2026-03-23T09:47:28.802Z'
amount: '50.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -6512,13 +6636,13 @@ paths:
id: ps_UkLWZg9DAJ
status: completed
currency: USD
- external_id: bogus_d8b2ff05b1a90aea9bd7d1cf
+ external_id: bogus_1203eaa7dad2d1565f80dfe9
external_data:
client_secret: secret_123
customer_external_id:
expires_at:
- created_at: '2026-03-23T07:55:20.872Z'
- updated_at: '2026-03-23T07:55:20.887Z'
+ created_at: '2026-03-23T09:47:29.413Z'
+ updated_at: '2026-03-23T09:47:29.426Z'
amount: '110.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -6598,11 +6722,11 @@ paths:
example:
id: pss_gbHJdmfrXB
status: pending
- external_id: bogus_seti_efd305130228f10e9f078e81
- external_client_secret: bogus_seti_secret_f236909d4aa857fa
+ external_id: bogus_seti_a3217c4fd5589f6395a5c1a7
+ external_client_secret: bogus_seti_secret_c66ed8871765fd18
external_data: {}
- created_at: '2026-03-23T07:55:22.121Z'
- updated_at: '2026-03-23T07:55:22.121Z'
+ created_at: '2026-03-23T09:47:30.605Z'
+ updated_at: '2026-03-23T09:47:30.605Z'
payment_method_id: pm_UkLWZg9DAJ
payment_source_id:
payment_source_type:
@@ -6699,12 +6823,12 @@ paths:
example:
id: pss_UkLWZg9DAJ
status: pending
- external_id: seti_test_1132de438ac92692871efb95
- external_client_secret: seti_secret_8a49a72045f4dadd1fcb1f07
+ external_id: seti_test_e3bf7e5234e5919f94846c90
+ external_client_secret: seti_secret_2ff694ec33af213a26c7684e
external_data:
client_secret: secret_123
- created_at: '2026-03-23T07:55:23.989Z'
- updated_at: '2026-03-23T07:55:23.989Z'
+ created_at: '2026-03-23T09:47:32.259Z'
+ updated_at: '2026-03-23T09:47:32.259Z'
payment_method_id: pm_UkLWZg9DAJ
payment_source_id:
payment_source_type:
@@ -6777,12 +6901,12 @@ paths:
example:
id: pss_UkLWZg9DAJ
status: completed
- external_id: seti_test_ff021fb26de9c07b6373f40b
- external_client_secret: seti_secret_2229096fac1b0d9a589c4eca
+ external_id: seti_test_75805f2d27b094d5f08a02f6
+ external_client_secret: seti_secret_770ce0b2607313ae9074ef6e
external_data:
client_secret: secret_123
- created_at: '2026-03-23T07:55:25.154Z'
- updated_at: '2026-03-23T07:55:25.179Z'
+ created_at: '2026-03-23T09:47:33.372Z'
+ updated_at: '2026-03-23T09:47:33.384Z'
payment_method_id: pm_UkLWZg9DAJ
payment_source_id: card_UkLWZg9DAJ
payment_source_type: Spree::CreditCard
@@ -6873,11 +6997,11 @@ paths:
id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
response_code:
- number: PB0GSFSV
+ number: PUATWDMA
amount: '110.0'
display_amount: "$110.00"
- created_at: '2026-03-23T07:55:26.430Z'
- updated_at: '2026-03-23T07:55:26.430Z'
+ created_at: '2026-03-23T09:47:34.576Z'
+ updated_at: '2026-03-23T09:47:34.576Z'
status: checkout
source_type:
source_id:
@@ -7035,14 +7159,14 @@ paths:
example:
data:
- id: prod_UkLWZg9DAJ
- name: Product 595582
- slug: product-595582
+ name: Product 598781
+ slug: product-598781
meta_description:
meta_keywords:
variant_count: 1
- available_on: '2025-03-23T07:55:27.123Z'
- created_at: '2026-03-23T07:55:27.136Z'
- updated_at: '2026-03-23T07:55:27.178Z'
+ available_on: '2025-03-23T09:47:35.225Z'
+ created_at: '2026-03-23T09:47:35.237Z'
+ updated_at: '2026-03-23T09:47:35.278Z'
purchasable: true
in_stock: false
backorderable: true
@@ -7064,37 +7188,24 @@ paths:
price_list_id:
original_price:
- id: prod_gbHJdmfrXB
- name: Product 608331
- slug: product-608331
+ name: Product 607832
+ slug: product-607832
meta_description:
meta_keywords:
variant_count: 0
- available_on: '2025-03-23T07:55:27.183Z'
- created_at: '2026-03-23T07:55:27.194Z'
- updated_at: '2026-03-23T07:55:27.210Z'
+ available_on: '2025-03-23T09:47:35.283Z'
+ created_at: '2026-03-23T09:47:35.292Z'
+ updated_at: '2026-03-23T09:47:35.303Z'
purchasable: true
in_stock: false
backorderable: true
available: true
- description: Illo veniam omnis quas nesciunt repudiandae molestiae
- quo. Enim dolorum odio velit optio. Ratione commodi exercitationem
- numquam excepturi similique. Architecto perferendis recusandae
- facere vel dicta quas. Alias officia quidem ipsam omnis molestiae.
- Necessitatibus nesciunt et voluptate impedit tempora fugit architecto
- harum. Molestiae ad labore fugiat quibusdam iusto. Neque eos enim
- molestias sed. Voluptas porro reiciendis quam aliquam illum accusamus
- illo. Doloremque eveniet autem incidunt corporis ipsum sequi.
- Cupiditate fugit iure maxime omnis. Autem totam natus magni labore
- hic. Iusto tempore ducimus sequi possimus rem. Voluptate eius
- molestiae magnam quas corporis omnis enim. Recusandae earum sunt
- cum illo perspiciatis. Ut natus maxime nemo delectus aperiam ipsam
- eveniet corrupti. Soluta sed culpa laborum libero ab ipsum harum
- vero.
- description_html: |-
- Illo veniam omnis quas nesciunt repudiandae molestiae quo. Enim dolorum odio velit optio. Ratione commodi exercitationem numquam excepturi similique. Architecto perferendis recusandae facere vel dicta quas.
- Alias officia quidem ipsam omnis molestiae. Necessitatibus nesciunt et voluptate impedit tempora fugit architecto harum. Molestiae ad labore fugiat quibusdam iusto.
- Neque eos enim molestias sed. Voluptas porro reiciendis quam aliquam illum accusamus illo. Doloremque eveniet autem incidunt corporis ipsum sequi. Cupiditate fugit iure maxime omnis. Autem totam natus magni labore hic.
- Iusto tempore ducimus sequi possimus rem. Voluptate eius molestiae magnam quas corporis omnis enim. Recusandae earum sunt cum illo perspiciatis. Ut natus maxime nemo delectus aperiam ipsam eveniet corrupti. Soluta sed culpa laborum libero ab ipsum harum vero.
+ description: Aut eos dolores vel earum quos ducimus. Exercitationem
+ inventore numquam culpa consequatur nesciunt. Sapiente vero quas
+ assumenda nisi.
+ description_html: Aut eos dolores vel earum quos ducimus. Exercitationem
+ inventore numquam culpa consequatur nesciunt. Sapiente vero quas
+ assumenda nisi.
default_variant_id: variant_EfhxLZ9ck8
thumbnail_url:
tags: []
@@ -7196,14 +7307,14 @@ paths:
application/json:
example:
id: prod_UkLWZg9DAJ
- name: Product 713203
- slug: product-713203
+ name: Product 714311
+ slug: product-714311
meta_description:
meta_keywords:
variant_count: 1
- available_on: '2025-03-23T07:55:27.792Z'
- created_at: '2026-03-23T07:55:27.806Z'
- updated_at: '2026-03-23T07:55:27.846Z'
+ available_on: '2025-03-23T09:47:35.850Z'
+ created_at: '2026-03-23T09:47:35.864Z'
+ updated_at: '2026-03-23T09:47:35.897Z'
purchasable: true
in_stock: false
backorderable: true
@@ -7369,6 +7480,173 @@ paths:
message: Valid API key required
schema:
"$ref": "#/components/schemas/ErrorResponse"
+ "/api/v3/store/customers/me/store_credits":
+ get:
+ summary: List store credits
+ tags:
+ - Customers
+ security:
+ - api_key: []
+ bearer_auth: []
+ description: Returns store credits for the authenticated customer, filtered
+ by current store and currency. Supports Ransack filtering.
+ x-codeSamples:
+ - lang: javascript
+ label: Spree SDK
+ source: |-
+ import { createClient } from '@spree/sdk'
+
+ const client = createClient({
+ baseUrl: 'https://your-store.com',
+ publishableKey: '<api-key>',
+ })
+
+ const credits = await client.customer.storeCredits.list({}, {
+ bearerToken: '<token>',
+ })
+ parameters:
+ - name: x-spree-api-key
+ in: header
+ required: true
+ schema:
+ type: string
+ - name: Authorization
+ in: header
+ required: true
+ schema:
+ type: string
+ - name: page
+ in: query
+ required: false
+ schema:
+ type: integer
+ - name: limit
+ in: query
+ required: false
+ schema:
+ type: integer
+ - name: fields
+ in: query
+ required: false
+ description: Comma-separated list of fields to include (e.g., amount,currency).
+ id is always included.
+ schema:
+ type: string
+ responses:
+ '200':
+ description: store credits found
+ content:
+ application/json:
+ example:
+ data:
+ - id: credit_UkLWZg9DAJ
+ amount: '100.0'
+ amount_used: '0.0'
+ amount_remaining: '100.0'
+ display_amount: "$100.00"
+ display_amount_used: "$0.00"
+ display_amount_remaining: "$100.00"
+ currency: USD
+ meta:
+ page: 1
+ limit: 25
+ count: 1
+ pages: 1
+ from: 1
+ to: 1
+ in: 1
+ previous:
+ next:
+ schema:
+ type: object
+ properties:
+ data:
+ type: array
+ items:
+ "$ref": "#/components/schemas/StoreCredit"
+ meta:
+ "$ref": "#/components/schemas/PaginationMeta"
+ '401':
+ description: unauthorized
+ content:
+ application/json:
+ example:
+ error:
+ code: authentication_required
+ message: Authentication required
+ schema:
+ "$ref": "#/components/schemas/ErrorResponse"
+ "/api/v3/store/customers/me/store_credits/{id}":
+ get:
+ summary: Get a store credit
+ tags:
+ - Customers
+ security:
+ - api_key: []
+ bearer_auth: []
+ x-codeSamples:
+ - lang: javascript
+ label: Spree SDK
+ source: |-
+ import { createClient } from '@spree/sdk'
+
+ const client = createClient({
+ baseUrl: 'https://your-store.com',
+ publishableKey: '<api-key>',
+ })
+
+ const credit = await client.customer.storeCredits.get('credit_abc123', {
+ bearerToken: '<token>',
+ })
+ parameters:
+ - name: x-spree-api-key
+ in: header
+ required: true
+ schema:
+ type: string
+ - name: Authorization
+ in: header
+ required: true
+ schema:
+ type: string
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ - name: fields
+ in: query
+ required: false
+ description: Comma-separated list of fields to include (e.g., amount,currency).
+ id is always included.
+ schema:
+ type: string
+ responses:
+ '200':
+ description: store credit found
+ content:
+ application/json:
+ example:
+ id: credit_UkLWZg9DAJ
+ amount: '100.0'
+ amount_used: '0.0'
+ amount_remaining: '100.0'
+ display_amount: "$100.00"
+ display_amount_used: "$0.00"
+ display_amount_remaining: "$100.00"
+ currency: USD
+ schema:
+ "$ref": "#/components/schemas/StoreCredit"
+ '404':
+ description: store credit not found
+ content:
+ application/json:
+ example:
+ error:
+ code: record_not_found
+ message: Store credit not found
+ schema:
+ "$ref": "#/components/schemas/ErrorResponse"
"/api/v3/store/carts/{cart_id}/store_credits":
post:
summary: Apply store credit
@@ -7427,9 +7705,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R444783865
- token: 1j3PRRbL9mrnuQBeWi65hNRMydkWLLnC77t
+ number: R456929816
+ token: x3ELcyvNAYUFmoXStUaRuALXebhvTRFKAMu
customer_note:
currency: USD
locale: en
@@ -7450,8 +7728,13 @@ paths:
display_total: "$110.00"
delivery_total: '100.0'
display_delivery_total: "$100.00"
- created_at: '2026-03-23T07:55:29.868Z'
- updated_at: '2026-03-23T07:55:29.919Z'
+ created_at: '2026-03-23T09:47:41.084Z'
+ updated_at: '2026-03-23T09:47:41.154Z'
+ store_credit_total: '10.0'
+ display_store_credit_total: "-$10.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
current_step: address
completed_steps: []
requirements: []
@@ -7462,8 +7745,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 99496
- slug: product-99496
+ name: Product 995483
+ slug: product-995483
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -7482,21 +7765,21 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:55:29.898Z'
- updated_at: '2026-03-23T07:55:29.898Z'
+ created_at: '2026-03-23T09:47:41.128Z'
+ updated_at: '2026-03-23T09:47:41.128Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H59677003567
+ number: H01423259125
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-23T07:55:29.903Z'
- updated_at: '2026-03-23T07:55:29.917Z'
+ created_at: '2026-03-23T09:47:41.134Z'
+ updated_at: '2026-03-23T09:47:41.151Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -7510,14 +7793,14 @@ paths:
code: UPS_GROUND
stock_location:
id: sloc_UkLWZg9DAJ
- state_abbr: STATE_ABBR_245
- name: Sunny Kuhn
+ state_abbr: STATE_ABBR_253
+ name: Tiana Kreiger
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
country_iso: US
country_name: United States of America
- state_text: STATE_ABBR_245
+ state_text: STATE_ABBR_253
delivery_rates:
- id: dr_UkLWZg9DAJ
delivery_method_id: dm_UkLWZg9DAJ
@@ -7532,12 +7815,12 @@ paths:
payments:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- response_code: 1-SC-20260323075530235200
- number: P6IXVEXS
+ response_code: 1-SC-20260323094741443566
+ number: P9DA8LE0
amount: '10.0'
display_amount: "$10.00"
- created_at: '2026-03-23T07:55:30.238Z'
- updated_at: '2026-03-23T07:55:30.238Z'
+ created_at: '2026-03-23T09:47:41.447Z'
+ updated_at: '2026-03-23T09:47:41.447Z'
status: checkout
source_type: store_credit
source_id: credit_UkLWZg9DAJ
@@ -7561,7 +7844,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 227 Lovely Street
+ address1: 235 Lovely Street
address2: Northwest
postal_code: '35005'
city: Herndon
@@ -7569,18 +7852,18 @@ paths:
company: Company
country_name: United States of America
country_iso: US
- state_text: STATE_ABBR_247
- state_abbr: STATE_ABBR_247
+ state_text: STATE_ABBR_255
+ state_abbr: STATE_ABBR_255
quick_checkout: false
is_default_billing: false
is_default_shipping: false
- state_name: STATE_NAME_247
+ state_name: STATE_NAME_255
shipping_address:
id: addr_VqXmZF31wY
first_name: John
last_name: Doe
full_name: John Doe
- address1: 228 Lovely Street
+ address1: 236 Lovely Street
address2: Northwest
postal_code: '35005'
city: Herndon
@@ -7588,18 +7871,19 @@ paths:
company: Company
country_name: United States of America
country_iso: US
- state_text: STATE_ABBR_248
- state_abbr: STATE_ABBR_248
+ state_text: STATE_ABBR_256
+ state_abbr: STATE_ABBR_256
quick_checkout: false
is_default_billing: false
is_default_shipping: false
- state_name: STATE_NAME_248
+ state_name: STATE_NAME_256
payment_methods:
- id: pm_UkLWZg9DAJ
name: Store Credit
description: Store Credit
type: Spree::PaymentMethod::StoreCredit
session_required: false
+ gift_card:
schema:
"$ref": "#/components/schemas/Cart"
'422':
@@ -7673,9 +7957,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R909199733
- token: GNxQMH2foANBpoN8me3nTWVvTG64NgJxQKh
+ number: R125138351
+ token: u5cMB6zXAHAKJwXmhnQVvWWjgaYWiw47cSr
customer_note:
currency: USD
locale: en
@@ -7696,8 +7980,13 @@ paths:
display_total: "$110.00"
delivery_total: '100.0'
display_delivery_total: "$100.00"
- created_at: '2026-03-23T07:55:31.427Z'
- updated_at: '2026-03-23T07:55:31.488Z'
+ created_at: '2026-03-23T09:47:42.634Z'
+ updated_at: '2026-03-23T09:47:42.686Z'
+ store_credit_total: '0.0'
+ display_store_credit_total: "$0.00"
+ gift_card_total: '0.0'
+ display_gift_card_total: "$0.00"
+ covered_by_store_credit: false
current_step: address
completed_steps: []
requirements:
@@ -7711,8 +8000,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 1015341
- slug: product-1015341
+ name: Product 1017022
+ slug: product-1017022
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -7731,21 +8020,21 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-23T07:55:31.465Z'
- updated_at: '2026-03-23T07:55:31.465Z'
+ created_at: '2026-03-23T09:47:42.664Z'
+ updated_at: '2026-03-23T09:47:42.664Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H09553879009
+ number: H35778067784
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-23T07:55:31.471Z'
- updated_at: '2026-03-23T07:55:31.486Z'
+ created_at: '2026-03-23T09:47:42.670Z'
+ updated_at: '2026-03-23T09:47:42.683Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -7759,14 +8048,14 @@ paths:
code: UPS_GROUND
stock_location:
id: sloc_UkLWZg9DAJ
- state_abbr: STATE_ABBR_253
- name: Chanda Stark
+ state_abbr: STATE_ABBR_261
+ name: Morton Barrows
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
country_iso: US
country_name: United States of America
- state_text: STATE_ABBR_253
+ state_text: STATE_ABBR_261
delivery_rates:
- id: dr_UkLWZg9DAJ
delivery_method_id: dm_UkLWZg9DAJ
@@ -7784,7 +8073,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 235 Lovely Street
+ address1: 243 Lovely Street
address2: Northwest
postal_code: '35005'
city: Herndon
@@ -7792,18 +8081,18 @@ paths:
company: Company
country_name: United States of America
country_iso: US
- state_text: STATE_ABBR_255
- state_abbr: STATE_ABBR_255
+ state_text: STATE_ABBR_263
+ state_abbr: STATE_ABBR_263
quick_checkout: false
is_default_billing: false
is_default_shipping: false
- state_name: STATE_NAME_255
+ state_name: STATE_NAME_263
shipping_address:
id: addr_VqXmZF31wY
first_name: John
last_name: Doe
full_name: John Doe
- address1: 236 Lovely Street
+ address1: 244 Lovely Street
address2: Northwest
postal_code: '35005'
city: Herndon
@@ -7811,13 +8100,14 @@ paths:
company: Company
country_name: United States of America
country_iso: US
- state_text: STATE_ABBR_256
- state_abbr: STATE_ABBR_256
+ state_text: STATE_ABBR_264
+ state_abbr: STATE_ABBR_264
quick_checkout: false
is_default_billing: false
is_default_shipping: false
- state_name: STATE_NAME_256
+ state_name: STATE_NAME_264
payment_methods: []
+ gift_card:
schema:
"$ref": "#/components/schemas/Cart"
"/api/v3/store/wishlists":
@@ -7880,9 +8170,9 @@ paths:
data:
- id: wl_UkLWZg9DAJ
name: My Wishlist
- token: 9XcGbzY1vVEp32e1uG9oSPko
- created_at: '2026-03-23T07:55:32.066Z'
- updated_at: '2026-03-23T07:55:32.066Z'
+ token: HcmzwPy6ZykCsCXQAKzsUbZ3
+ created_at: '2026-03-23T09:47:43.258Z'
+ updated_at: '2026-03-23T09:47:43.258Z'
is_default: false
is_private: true
meta:
@@ -7958,9 +8248,9 @@ paths:
example:
id: wl_gbHJdmfrXB
name: Birthday Ideas
- token: inmJKZ6hVhigSEKRNQBFRxDb
- created_at: '2026-03-23T07:55:33.271Z'
- updated_at: '2026-03-23T07:55:33.271Z'
+ token: W3gCY6dcqoqXaW5TVrYihQYQ
+ created_at: '2026-03-23T09:47:44.460Z'
+ updated_at: '2026-03-23T09:47:44.460Z'
is_default: false
is_private: true
schema:
@@ -8056,9 +8346,9 @@ paths:
example:
id: wl_UkLWZg9DAJ
name: My Wishlist
- token: kpKXg1Do4z4YVeFzQS66ZP5W
- created_at: '2026-03-23T07:55:34.428Z'
- updated_at: '2026-03-23T07:55:34.428Z'
+ token: ZcKczuWt69M5SGyn9zneXbfS
+ created_at: '2026-03-23T09:47:45.582Z'
+ updated_at: '2026-03-23T09:47:45.582Z'
is_default: false
is_private: true
schema:
@@ -8120,9 +8410,9 @@ paths:
example:
id: wl_UkLWZg9DAJ
name: Updated Name
- token: Ce3SByaGSdZDLRofNENh221G
- created_at: '2026-03-23T07:55:35.674Z'
- updated_at: '2026-03-23T07:55:35.719Z'
+ token: yheHzdKp69kba6YGxCNsGdXm
+ created_at: '2026-03-23T09:47:46.748Z'
+ updated_at: '2026-03-23T09:47:46.788Z'
is_default: false
is_private: true
schema:
@@ -8234,8 +8524,8 @@ paths:
variant_id: variant_gbHJdmfrXB
wishlist_id: wl_UkLWZg9DAJ
quantity: 1
- created_at: '2026-03-23T07:55:36.906Z'
- updated_at: '2026-03-23T07:55:36.906Z'
+ created_at: '2026-03-23T09:47:47.987Z'
+ updated_at: '2026-03-23T09:47:47.987Z'
variant:
id: variant_gbHJdmfrXB
product_id: prod_gbHJdmfrXB
@@ -8243,8 +8533,8 @@ paths:
options_text: ''
track_inventory: true
media_count: 0
- created_at: '2026-03-23T07:55:36.881Z'
- updated_at: '2026-03-23T07:55:36.891Z'
+ created_at: '2026-03-23T09:47:47.962Z'
+ updated_at: '2026-03-23T09:47:47.973Z'
thumbnail_url:
purchasable: true
in_stock: false
@@ -8669,6 +8959,16 @@ components:
type: string
updated_at:
type: string
+ store_credit_total:
+ type: string
+ display_store_credit_total:
+ type: string
+ gift_card_total:
+ type: string
+ display_gift_card_total:
+ type: string
+ covered_by_store_credit:
+ type: boolean
current_step:
type: string
completed_steps:
@@ -8709,6 +9009,10 @@ components:
type: array
items:
"$ref": "#/components/schemas/PaymentMethod"
+ gift_card:
+ allOf:
+ - "$ref": "#/components/schemas/GiftCard"
+ nullable: true
required:
- id
- number
@@ -8736,6 +9040,11 @@ components:
- display_delivery_total
- created_at
- updated_at
+ - store_credit_total
+ - display_store_credit_total
+ - gift_card_total
+ - display_gift_card_total
+ - covered_by_store_credit
- current_step
- completed_steps
- requirements
@@ -8747,6 +9056,7 @@ components:
- billing_address
- shipping_address
- payment_methods
+ - gift_card
x-typelizer: true
Category:
type: object
@@ -8925,6 +9235,10 @@ components:
type: string
updated_at:
type: string
+ available_store_credit_total:
+ type: string
+ display_available_store_credit_total:
+ type: string
addresses:
type: array
items:
@@ -8946,6 +9260,8 @@ components:
- accepts_email_marketing
- created_at
- updated_at
+ - available_store_credit_total
+ - display_available_store_credit_total
- addresses
- default_billing_address
- default_shipping_address
@@ -9653,6 +9969,16 @@ components:
type: string
updated_at:
type: string
+ store_credit_total:
+ type: string
+ display_store_credit_total:
+ type: string
+ gift_card_total:
+ type: string
+ display_gift_card_total:
+ type: string
+ covered_by_store_credit:
+ type: boolean
discounts:
type: array
items:
@@ -9677,6 +10003,10 @@ components:
allOf:
- "$ref": "#/components/schemas/Address"
nullable: true
+ gift_card:
+ allOf:
+ - "$ref": "#/components/schemas/GiftCard"
+ nullable: true
required:
- id
- number
@@ -9706,12 +10036,18 @@ components:
- completed_at
- created_at
- updated_at
+ - store_credit_total
+ - display_store_credit_total
+ - gift_card_total
+ - display_gift_card_total
+ - covered_by_store_credit
- discounts
- items
- fulfillments
- payments
- billing_address
- shipping_address
+ - gift_card
x-typelizer: true
PaymentMethod:
type: object
diff --git a/docs/developer/sdk/store/account.mdx b/docs/developer/sdk/store/account.mdx
index bf6788ace5..a4d023b12f 100644
--- a/docs/developer/sdk/store/account.mdx
+++ b/docs/developer/sdk/store/account.mdx
@@ -10,6 +10,7 @@ const options = { token: jwtToken };
// Get profile
const profile = await client.customer.get(options);
+// profile includes `available_store_credit_total` and `display_available_store_credit_total`
// Update profile
await client.customer.update({
@@ -38,17 +39,31 @@ await client.customer.addresses.create({
postal_code: '10001',
country_iso: 'US',
state_abbr: 'NY',
+ is_default_billing: true, // Optional — set as default billing address
+ is_default_shipping: true, // Optional — set as default shipping address
}, options);
// Update address
-await client.customer.addresses.update('addr_xxx', { city: 'Brooklyn' }, options);
+await client.customer.addresses.update('addr_xxx', {
+ city: 'Brooklyn',
+ is_default_billing: true, // Optional — set as default billing address
+ is_default_shipping: false, // Optional — set as default shipping address
+}, options);
// Delete address
await client.customer.addresses.delete('addr_xxx', options);
+```
+
+## Store Credits
+
+```typescript
+const options = { token: jwtToken };
+
+// List store credits
+const { data: credits } = await client.customer.storeCredits.list({}, options);
-// Mark as default billing or shipping address
-await client.customer.addresses.markAsDefault('addr_xxx', 'billing', options);
-await client.customer.addresses.markAsDefault('addr_xxx', 'shipping', options);
+// Get a specific store credit
+const credit = await client.customer.storeCredits.get('sc_xxx', options);
```
## Credit Cards
diff --git a/docs/developer/sdk/store/cart-checkout.mdx b/docs/developer/sdk/store/cart-checkout.mdx
index 58add8cac4..99349504a2 100644
--- a/docs/developer/sdk/store/cart-checkout.mdx
+++ b/docs/developer/sdk/store/cart-checkout.mdx
@@ -96,11 +96,14 @@ await client.carts.complete(cartId, { spreeToken: cart.token });
### Fulfillments
+Fulfillments are included in the cart response — there is no separate list endpoint.
+
```typescript
const options = { spreeToken: cart.token };
-// List fulfillments
-const fulfillments = await client.carts.fulfillments.list(cartId, options);
+// Access fulfillments from the cart response
+const cart = await client.carts.get(cartId, options);
+const fulfillments = cart.fulfillments;
// Select a delivery rate
await client.carts.fulfillments.update(cartId, fulfillmentId, {
@@ -123,6 +126,13 @@ await client.carts.storeCredits.apply(cartId, 25.00, options);
await client.carts.storeCredits.remove(cartId, options);
```
+The cart/order response includes store credit and gift card totals:
+
+- `store_credit_total` / `display_store_credit_total` — total store credit applied
+- `gift_card_total` / `display_gift_card_total` — total gift card value applied
+- `covered_by_store_credit` — boolean, whether the order is fully covered by store credit
+- `gift_card` — associated gift card (if applicable)
+
## Orders
### Get a Completed Order
diff --git a/docs/developer/sdk/store/payments.mdx b/docs/developer/sdk/store/payments.mdx
index 0fecd5d4ae..059599922a 100644
--- a/docs/developer/sdk/store/payments.mdx
+++ b/docs/developer/sdk/store/payments.mdx
@@ -7,13 +7,18 @@ All payment and delivery endpoints require a `cartId` as the first argument.
## Payment Methods
+Payment methods, payments, and fulfillments are included in the cart response -- there are no separate list or get endpoints for these resources.
+
```typescript
const options = { spreeToken: cart.token };
-// Get available payment methods for the current cart
-const methods = await client.carts.paymentMethods.list(cartId, options);
+// Access payment methods, payments, and fulfillments from the cart response
+const cart = await client.carts.get(cartId, options);
+const paymentMethods = cart.payment_methods;
+const payments = cart.payments;
+const fulfillments = cart.fulfillments;
-// Each method includes a `session_required` flag:
+// Each payment method includes a `session_required` flag:
// - true → use Payment Sessions (Stripe, Adyen, PayPal, etc.)
// - false → use direct payment creation (Check, Cash on Delivery, Bank Transfer, etc.)
```
@@ -23,12 +28,6 @@ const methods = await client.carts.paymentMethods.list(cartId, options);
```typescript
const options = { spreeToken: cart.token };
-// List payments on the current cart
-const payments = await client.carts.payments.list(cartId, options);
-
-// Get a specific payment
-const payment = await client.carts.payments.get(cartId, paymentId, options);
-
// Create a payment for a non-session payment method
// (e.g. Check, Cash on Delivery, Bank Transfer, Purchase Order)
const payment = await client.carts.payments.create(cartId, {
@@ -88,8 +87,9 @@ console.log(completed.status); // 'completed'
```typescript
const options = { spreeToken: cart.token };
-// List fulfillments for the current cart
-const fulfillments = await client.carts.fulfillments.list(cartId, options);
+// Fulfillments are included in the cart response
+const cart = await client.carts.get(cartId, options);
+const fulfillments = cart.fulfillments;
// Select a delivery rate
await client.carts.fulfillments.update(cartId, fulfillmentId, {
diff --git a/packages/admin-sdk/src/types/generated/Customer.ts b/packages/admin-sdk/src/types/generated/Customer.ts
index 7e64cdc467..1b12f75090 100644
--- a/packages/admin-sdk/src/types/generated/Customer.ts
+++ b/packages/admin-sdk/src/types/generated/Customer.ts
@@ -1,4 +1,4 @@
-// Typelizer digest c8bb3669fbba268316a8b2707348b6cf
+// Typelizer digest 4af376776a7a85e006e272e72b1607c6
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Address, Order} from '@/types'
@@ -12,6 +12,8 @@ interface Customer {
accepts_email_marketing: boolean;
created_at: string;
updated_at: string;
+ available_store_credit_total: string;
+ display_available_store_credit_total: string;
addresses?: Array<Address>;
default_billing_address?: Address | null;
default_shipping_address?: Address | null;
diff --git a/packages/admin-sdk/src/types/generated/GiftCard.ts b/packages/admin-sdk/src/types/generated/GiftCard.ts
new file mode 100644
index 0000000000..45551b41e3
--- /dev/null
+++ b/packages/admin-sdk/src/types/generated/GiftCard.ts
@@ -0,0 +1,26 @@
+// Typelizer digest ccc8af4574069522197830b03a5d7878
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+
+interface GiftCard {
+ id: string;
+ code: string;
+ status: string;
+ currency: string;
+ amount: string;
+ amount_used: string;
+ amount_authorized: string;
+ amount_remaining: string;
+ display_amount: string;
+ display_amount_used: string;
+ display_amount_remaining: string;
+ expires_at: string | null;
+ redeemed_at: string | null;
+ expired: boolean;
+ active: boolean;
+ created_at: string;
+ updated_at: string;
+ metadata: Record<string, unknown> | null;
+}
+
+export default GiftCard;
diff --git a/packages/admin-sdk/src/types/generated/Order.ts b/packages/admin-sdk/src/types/generated/Order.ts
index 78e75fc2be..e7d3fd9084 100644
--- a/packages/admin-sdk/src/types/generated/Order.ts
+++ b/packages/admin-sdk/src/types/generated/Order.ts
@@ -1,7 +1,7 @@
-// Typelizer digest e9f22c33153041c7b0cac12f9090b045
+// Typelizer digest a7e33dabfb090e2a86fed6b6aa3c0621
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {Discount, LineItem, Fulfillment, Payment, Address, PaymentMethod, Customer, Adjustment, ReturnAuthorization, Reimbursement} from '@/types'
+import type {Discount, LineItem, Fulfillment, Payment, Address, GiftCard, PaymentMethod, Customer, Adjustment, ReturnAuthorization, Reimbursement} from '@/types'
interface Order {
id: string;
@@ -32,12 +32,18 @@ interface Order {
completed_at: string | null;
created_at: string;
updated_at: string;
+ store_credit_total: string;
+ display_store_credit_total: string;
+ gift_card_total: string;
+ display_gift_card_total: string;
+ covered_by_store_credit: boolean;
discounts?: Array<Discount>;
items?: Array<LineItem>;
fulfillments?: Array<Fulfillment>;
payments?: Array<Payment>;
billing_address?: Address | null;
shipping_address?: Address | null;
+ gift_card: GiftCard | null;
channel: string | null;
last_ip_address: string | null;
considered_risky: boolean;
diff --git a/packages/admin-sdk/src/types/generated/index.ts b/packages/admin-sdk/src/types/generated/index.ts
index db043e7f6d..10d55dce1c 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 1ec13db8677848368e2a73b2ae1a9f0e
+// Typelizer digest 1eda61f4ba3c7a33117be3b111c2fc09
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
export type { default as Address } from './Address'
@@ -14,6 +14,7 @@ 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 GiftCard } from './GiftCard'
export type { default as LineItem } from './LineItem'
export type { default as Media } from './Media'
export type { default as Metafield } from './Metafield'
diff --git a/packages/next/.changeset/store-api-cleanup.md b/packages/next/.changeset/store-api-cleanup.md
deleted file mode 100644
index 922dfa7657..0000000000
--- a/packages/next/.changeset/store-api-cleanup.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-"@spree/next": minor
----
-
-**Breaking:** Removed `getFulfillments()` server action — fulfillments are included in the cart response. Use `cart.fulfillments` instead.
-
-Requires `@spree/sdk` >= 0.12.0.
diff --git a/packages/next/CHANGELOG.md b/packages/next/CHANGELOG.md
index 86a547ba76..b29c8af1f5 100644
--- a/packages/next/CHANGELOG.md
+++ b/packages/next/CHANGELOG.md
@@ -1,5 +1,15 @@
# @spree/next
+## 0.15.0
+
+### Minor Changes
+
+**Breaking:** Removed `getFulfillments()` server action — fulfillments are included in the cart response. Use `cart.fulfillments` instead.
+
+**New:** Added `listStoreCredits()` server action and `StoreCredit` type re-export.
+
+Requires `@spree/sdk` >= 0.15.0.
+
## 0.14.1
### Patch Changes
diff --git a/packages/next/README.md b/packages/next/README.md
index 9b42fe2fe2..782d3b0045 100644
--- a/packages/next/README.md
+++ b/packages/next/README.md
@@ -144,7 +144,6 @@ All checkout functions operate on the current cart implicitly (via the cart cook
import {
getCheckout,
updateCheckout,
- getFulfillments,
selectDeliveryRate,
applyCoupon,
removeCoupon,
@@ -152,8 +151,9 @@ import {
} from '@spree/next';
const checkout = await getCheckout();
+// Fulfillments are included in the checkout/cart response:
+// checkout.fulfillments
await updateCheckout({ shipping_address: { ... }, billing_address: { ... } });
-const fulfillments = await getFulfillments();
await selectDeliveryRate(fulfillmentId, rateId);
await applyCoupon('SAVE20');
await removeCoupon('SAVE20');
@@ -254,6 +254,15 @@ await updatePaymentSession(sessionId, { amount: '50.00' });
await completePaymentSession(sessionId, { session_result: 'success' });
```
+### Store Credits
+
+```typescript
+import { listStoreCredits, getStoreCredit } from '@spree/next';
+
+const credits = await listStoreCredits();
+const credit = await getStoreCredit(creditId);
+```
+
### Credit Cards & Gift Cards
```typescript
diff --git a/packages/next/package.json b/packages/next/package.json
index 6fcfc496c1..de5ed42ffd 100644
--- a/packages/next/package.json
+++ b/packages/next/package.json
@@ -1,6 +1,6 @@
{
"name": "@spree/next",
- "version": "0.14.1",
+ "version": "0.15.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.14.2",
+ "@spree/sdk": ">=0.15.0",
"next": ">=15.0.0",
"react": ">=19.0.0"
},
diff --git a/packages/next/src/actions/store-credits.ts b/packages/next/src/actions/store-credits.ts
new file mode 100644
index 0000000000..2d93f3f782
--- /dev/null
+++ b/packages/next/src/actions/store-credits.ts
@@ -0,0 +1,17 @@
+'use server';
+
+import type { StoreCredit, PaginatedResponse, ListParams } from '@spree/sdk';
+import { withAuthRefresh } from '../auth-helpers';
+import { getClient } from '../config';
+
+/**
+ * List store credits for the authenticated customer.
+ * Filtered by current store and currency on the backend.
+ */
+export async function listStoreCredits(
+ params?: ListParams
+): Promise<PaginatedResponse<StoreCredit>> {
+ return withAuthRefresh(async (options) => {
+ return getClient().customer.storeCredits.list(params, options);
+ });
+}
diff --git a/packages/next/src/index.ts b/packages/next/src/index.ts
index 4a4de50269..ee3987d8e5 100644
--- a/packages/next/src/index.ts
+++ b/packages/next/src/index.ts
@@ -48,6 +48,7 @@ export { listOrders, getOrder } from './actions/orders';
export { setLocale } from './actions/locale';
export { listCreditCards, deleteCreditCard } from './actions/credit-cards';
export { listGiftCards, getGiftCard } from './actions/gift-cards';
+export { listStoreCredits } from './actions/store-credits';
export { createPayment } from './actions/payments';
@@ -81,6 +82,7 @@ export type {
CreditCard,
DigitalLink,
GiftCard,
+ StoreCredit,
Fulfillment,
DeliveryRate,
Payment,
diff --git a/packages/sdk/.changeset/store-api-cleanup.md b/packages/sdk/.changeset/store-api-cleanup.md
deleted file mode 100644
index dcbb6116d4..0000000000
--- a/packages/sdk/.changeset/store-api-cleanup.md
+++ /dev/null
@@ -1,10 +0,0 @@
----
-"@spree/sdk": minor
----
-
-**Breaking:** Store API endpoint changes requiring backend >= 5.4.0.rc2:
-
-- **Default address:** Removed `markAsDefault()` method. Use `is_default_billing` / `is_default_shipping` booleans on `create()` and `update()` instead (Medusa/Vendure pattern)
-- **Removed redundant endpoints:** `carts.paymentMethods.list()`, `carts.payments.list()`, `carts.payments.get()`, `carts.fulfillments.list()` — payment methods, payments, and fulfillments are included in the cart response
-- **`AddressParams`** now includes `is_default_billing` and `is_default_shipping` fields
-- **Address response** now includes `is_default_billing` and `is_default_shipping` fields
diff --git a/packages/sdk/CHANGELOG.md b/packages/sdk/CHANGELOG.md
index 691752bfc4..8eb8ff8ce9 100644
--- a/packages/sdk/CHANGELOG.md
+++ b/packages/sdk/CHANGELOG.md
@@ -1,5 +1,19 @@
# @spree/sdk
+## 0.15.0
+
+### Minor Changes
+
+**Breaking:** Store API endpoint changes requiring backend >= 5.4.0.rc2:
+
+- **Default address:** Removed `markAsDefault()` method. Use `is_default_billing` / `is_default_shipping` booleans on `create()` and `update()` instead (Medusa/Vendure pattern)
+- **Removed redundant endpoints:** `carts.paymentMethods.list()`, `carts.payments.list()`, `carts.payments.get()`, `carts.fulfillments.list()` — payment methods, payments, and fulfillments are included in the cart response
+- **`AddressParams`** now includes `is_default_billing` and `is_default_shipping` fields
+- **Address response** now includes `is_default_billing` and `is_default_shipping` fields
+- **Cart/Order response** now includes `store_credit_total`, `gift_card_total`, `covered_by_store_credit`, and `gift_card` association
+- **Customer response** now includes `available_store_credit_total`
+- **New endpoint:** `customer.storeCredits.list()` and `customer.storeCredits.get()` — store credits for the authenticated customer
+
## 0.14.2
### Patch Changes
diff --git a/packages/sdk/README.md b/packages/sdk/README.md
index 8e3e344d6b..394293b63c 100644
--- a/packages/sdk/README.md
+++ b/packages/sdk/README.md
@@ -557,6 +557,7 @@ The SDK uses a resource builder pattern for nested resources:
| `customer` | `passwordResets` | `create`, `update` |
| `customer` | `creditCards` | `list`, `get`, `delete` |
| `customer` | `giftCards` | `list`, `get` |
+| `customer` | `storeCredits` | `list`, `get` |
| `customer` | `orders` | `list`, `get` |
| `markets` | `countries` | `list`, `get` |
| `categories` | `products` | `list` |
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
index a3ec8e60f9..daa0093856 100644
--- a/packages/sdk/package.json
+++ b/packages/sdk/package.json
@@ -1,6 +1,6 @@
{
"name": "@spree/sdk",
- "version": "0.14.2",
+ "version": "0.15.0",
"description": "Official TypeScript SDK for Spree Commerce Store API",
"type": "module",
"main": "./dist/index.cjs",
diff --git a/packages/sdk/src/store-client.ts b/packages/sdk/src/store-client.ts
index 204b6b6c09..93f0b0e5cf 100644
--- a/packages/sdk/src/store-client.ts
+++ b/packages/sdk/src/store-client.ts
@@ -40,6 +40,7 @@ import type {
Payment,
PaymentSession,
PaymentSetupSession,
+ StoreCredit,
Wishlist,
WishlistItem,
Address,
@@ -757,6 +758,32 @@ export class StoreClient {
this.request<GiftCard>('GET', `/customers/me/gift_cards/${id}`, options),
},
+ /**
+ * Nested resource: Store Credits
+ */
+ storeCredits: {
+ /**
+ * List store credits for the authenticated customer.
+ * Filtered by current store and currency.
+ * Supports Ransack filtering (e.g. `q[amount_remaining_gt]: 0`).
+ */
+ list: (
+ params?: ListParams,
+ options?: RequestOptions
+ ): Promise<PaginatedResponse<StoreCredit>> =>
+ this.request<PaginatedResponse<StoreCredit>>(
+ 'GET',
+ '/customers/me/store_credits',
+ { ...options, params: transformListParams({ ...params }) }
+ ),
+
+ /**
+ * Get a store credit by ID
+ */
+ get: (id: string, options?: RequestOptions): Promise<StoreCredit> =>
+ this.request<StoreCredit>('GET', `/customers/me/store_credits/${id}`, options),
+ },
+
/**
* Nested resource: Orders (customer order history)
*/
diff --git a/packages/sdk/src/types/generated/Cart.ts b/packages/sdk/src/types/generated/Cart.ts
index 36d1a2356d..af5c00d653 100644
--- a/packages/sdk/src/types/generated/Cart.ts
+++ b/packages/sdk/src/types/generated/Cart.ts
@@ -1,7 +1,7 @@
-// Typelizer digest 2789800eb336cf54875db1e9ed6cc5cb
+// Typelizer digest 74ce38d1c39231cbe9767dd3b5caeed6
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {Discount, LineItem, Fulfillment, Payment, Address, PaymentMethod} from '@/types'
+import type {Discount, LineItem, Fulfillment, Payment, Address, PaymentMethod, GiftCard} from '@/types'
interface Cart {
id: string;
@@ -30,6 +30,11 @@ interface Cart {
display_delivery_total: string;
created_at: string;
updated_at: string;
+ store_credit_total: string;
+ display_store_credit_total: string;
+ gift_card_total: string;
+ display_gift_card_total: string;
+ covered_by_store_credit: boolean;
current_step: string;
completed_steps: Array<string>;
requirements: Array<{step: string, field: string, message: string}>;
@@ -41,6 +46,7 @@ interface Cart {
billing_address: Address | null;
shipping_address: Address | null;
payment_methods: Array<PaymentMethod>;
+ gift_card: GiftCard | null;
}
export default Cart;
diff --git a/packages/sdk/src/types/generated/Customer.ts b/packages/sdk/src/types/generated/Customer.ts
index 55e1cb6973..fca0a01481 100644
--- a/packages/sdk/src/types/generated/Customer.ts
+++ b/packages/sdk/src/types/generated/Customer.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 167ac0b0e61ce6ff4e4f112673cd0fbb
+// Typelizer digest cfc7405abc8e1bdebb0b500ec1adf80a
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Address} from '@/types'
@@ -12,6 +12,8 @@ interface Customer {
accepts_email_marketing: boolean;
created_at: string;
updated_at: string;
+ available_store_credit_total: string;
+ display_available_store_credit_total: string;
addresses: Array<Address>;
default_billing_address: Address | null;
default_shipping_address: Address | null;
diff --git a/packages/sdk/src/types/generated/Order.ts b/packages/sdk/src/types/generated/Order.ts
index 4c15deebc7..8bca44fc54 100644
--- a/packages/sdk/src/types/generated/Order.ts
+++ b/packages/sdk/src/types/generated/Order.ts
@@ -1,7 +1,7 @@
-// Typelizer digest a46934883d428ccd5269d68536b8af5f
+// Typelizer digest 74b33a5de110af2129d54f1454d86b5f
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {Discount, LineItem, Fulfillment, Payment, Address} from '@/types'
+import type {Discount, LineItem, Fulfillment, Payment, Address, GiftCard} from '@/types'
interface Order {
id: string;
@@ -32,12 +32,18 @@ interface Order {
completed_at: string | null;
created_at: string;
updated_at: string;
+ store_credit_total: string;
+ display_store_credit_total: string;
+ gift_card_total: string;
+ display_gift_card_total: string;
+ covered_by_store_credit: boolean;
discounts: Array<Discount>;
items: Array<LineItem>;
fulfillments: Array<Fulfillment>;
payments: Array<Payment>;
billing_address: Address | null;
shipping_address: Address | null;
+ gift_card: GiftCard | null;
}
export default Order;
diff --git a/packages/sdk/src/zod/generated/Cart.ts b/packages/sdk/src/zod/generated/Cart.ts
index 256cf5130d..2cc9611284 100644
--- a/packages/sdk/src/zod/generated/Cart.ts
+++ b/packages/sdk/src/zod/generated/Cart.ts
@@ -3,6 +3,7 @@ import { z } from 'zod';
import { AddressSchema } from './Address';
import { DiscountSchema } from './Discount';
import { FulfillmentSchema } from './Fulfillment';
+import { GiftCardSchema } from './GiftCard';
import { LineItemSchema } from './LineItem';
import { PaymentSchema } from './Payment';
import { PaymentMethodSchema } from './PaymentMethod';
@@ -34,6 +35,11 @@ export const CartSchema = z.object({
display_delivery_total: z.string(),
created_at: z.string(),
updated_at: z.string(),
+ store_credit_total: z.string(),
+ display_store_credit_total: z.string(),
+ gift_card_total: z.string(),
+ display_gift_card_total: z.string(),
+ covered_by_store_credit: z.boolean(),
current_step: z.string(),
completed_steps: z.array(z.string()),
requirements: z.array(z.object({ step: z.string(), field: z.string(), message: z.string() })),
@@ -45,6 +51,7 @@ export const CartSchema = z.object({
billing_address: AddressSchema.nullable(),
shipping_address: AddressSchema.nullable(),
payment_methods: z.array(PaymentMethodSchema),
+ gift_card: GiftCardSchema.nullable(),
});
export type Cart = z.infer<typeof CartSchema>;
diff --git a/packages/sdk/src/zod/generated/Customer.ts b/packages/sdk/src/zod/generated/Customer.ts
index f3e4d2b106..e826a9430a 100644
--- a/packages/sdk/src/zod/generated/Customer.ts
+++ b/packages/sdk/src/zod/generated/Customer.ts
@@ -11,6 +11,8 @@ export const CustomerSchema = z.object({
accepts_email_marketing: z.boolean(),
created_at: z.string(),
updated_at: z.string(),
+ available_store_credit_total: z.string(),
+ display_available_store_credit_total: z.string(),
addresses: z.array(AddressSchema),
default_billing_address: AddressSchema.nullable(),
default_shipping_address: AddressSchema.nullable(),
diff --git a/packages/sdk/src/zod/generated/Order.ts b/packages/sdk/src/zod/generated/Order.ts
index 0bf55f4620..ca16562bbe 100644
--- a/packages/sdk/src/zod/generated/Order.ts
+++ b/packages/sdk/src/zod/generated/Order.ts
@@ -3,6 +3,7 @@ import { z } from 'zod';
import { AddressSchema } from './Address';
import { DiscountSchema } from './Discount';
import { FulfillmentSchema } from './Fulfillment';
+import { GiftCardSchema } from './GiftCard';
import { LineItemSchema } from './LineItem';
import { PaymentSchema } from './Payment';
@@ -35,12 +36,18 @@ export const OrderSchema = z.object({
completed_at: z.string().nullable(),
created_at: z.string(),
updated_at: z.string(),
+ store_credit_total: z.string(),
+ display_store_credit_total: z.string(),
+ gift_card_total: z.string(),
+ display_gift_card_total: z.string(),
+ covered_by_store_credit: z.boolean(),
discounts: z.array(DiscountSchema),
items: z.array(LineItemSchema),
fulfillments: z.array(FulfillmentSchema),
payments: z.array(PaymentSchema),
billing_address: AddressSchema.nullable(),
shipping_address: AddressSchema.nullable(),
+ gift_card: GiftCardSchema.nullable(),
});
export type Order = z.infer<typeof OrderSchema>;
diff --git a/packages/sdk/tests/customer.test.ts b/packages/sdk/tests/customer.test.ts
index 557ccc568e..a1fd2d2021 100644
--- a/packages/sdk/tests/customer.test.ts
+++ b/packages/sdk/tests/customer.test.ts
@@ -134,4 +134,21 @@ describe('customer', () => {
expect(result).toBeDefined();
});
});
+
+ describe('storeCredits', () => {
+ it('lists store credits', async () => {
+ const result = await client.customer.storeCredits.list(undefined, opts);
+ expect(result.data).toHaveLength(1);
+ expect(result.data[0].id).toBe('credit_1');
+ expect(result.data[0].amount).toBe('100.00');
+ expect(result.data[0].amount_remaining).toBe('75.00');
+ expect(result.data[0].currency).toBe('USD');
+ });
+
+ it('gets a store credit by ID', async () => {
+ const result = await client.customer.storeCredits.get('credit_1', opts);
+ expect(result.id).toBe('credit_1');
+ expect(result.amount).toBe('100.00');
+ });
+ });
});
diff --git a/packages/sdk/tests/mocks/handlers.ts b/packages/sdk/tests/mocks/handlers.ts
index 068b3bd144..53fb86fe1f 100644
--- a/packages/sdk/tests/mocks/handlers.ts
+++ b/packages/sdk/tests/mocks/handlers.ts
@@ -423,6 +423,36 @@ export const handlers = [
HttpResponse.json({ id: 'gc_1', code: 'GIFT123', balance: '50.00' })
),
+ // Customer > Store Credits
+ http.get(`${API_PREFIX}/customers/me/store_credits`, () =>
+ HttpResponse.json({
+ data: [{
+ id: 'credit_1',
+ amount: '100.00',
+ amount_used: '25.00',
+ amount_remaining: '75.00',
+ display_amount: '$100.00',
+ display_amount_used: '$25.00',
+ display_amount_remaining: '$75.00',
+ currency: 'USD',
+ }],
+ meta: paginationMeta,
+ })
+ ),
+
+ http.get(`${API_PREFIX}/customers/me/store_credits/:id`, () =>
+ HttpResponse.json({
+ id: 'credit_1',
+ amount: '100.00',
+ amount_used: '25.00',
+ amount_remaining: '75.00',
+ display_amount: '$100.00',
+ display_amount_used: '$25.00',
+ display_amount_remaining: '$75.00',
+ currency: 'USD',
+ })
+ ),
+
// Customer > Payment Setup Sessions
http.post(`${API_PREFIX}/customers/me/payment_setup_sessions`, () =>
HttpResponse.json({
diff --git a/spree/api/app/controllers/spree/api/v3/store/customer/store_credits_controller.rb b/spree/api/app/controllers/spree/api/v3/store/customer/store_credits_controller.rb
new file mode 100644
index 0000000000..7e3fc3b1ed
--- /dev/null
+++ b/spree/api/app/controllers/spree/api/v3/store/customer/store_credits_controller.rb
@@ -0,0 +1,39 @@
+module Spree
+ module Api
+ module V3
+ module Store
+ module Customer
+ class StoreCreditsController < ResourceController
+ prepend_before_action :require_authentication!
+
+ protected
+
+ def set_parent
+ @parent = current_user
+ end
+
+ def parent_association
+ :store_credits
+ end
+
+ def scope
+ super.for_store(current_store).where(currency: current_currency)
+ end
+
+ def model_class
+ Spree::StoreCredit
+ end
+
+ def serializer_class
+ Spree.api.store_credit_serializer
+ end
+
+ # Authorization is handled by set_parent scoping to current_user
+ def authorize_resource!(*)
+ end
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/gift_card_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/gift_card_serializer.rb
new file mode 100644
index 0000000000..b3dc9527d6
--- /dev/null
+++ b/spree/api/app/serializers/spree/api/v3/admin/gift_card_serializer.rb
@@ -0,0 +1,17 @@
+module Spree
+ module Api
+ module V3
+ module Admin
+ class GiftCardSerializer < V3::GiftCardSerializer
+ typelize metadata: 'Record<string, unknown> | null'
+
+ attribute :metadata do |gift_card|
+ gift_card.metadata.presence
+ end
+
+ attributes created_at: :iso8601, updated_at: :iso8601
+ end
+ end
+ 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 9a915727a4..14bb8623fe 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
@@ -50,6 +50,7 @@ module Spree
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') }
+ one :gift_card, resource: Spree.api.admin_gift_card_serializer
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/cart_serializer.rb b/spree/api/app/serializers/spree/api/v3/cart_serializer.rb
index 4ba3b22b41..6b4414d5b0 100644
--- a/spree/api/app/serializers/spree/api/v3/cart_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/cart_serializer.rb
@@ -14,9 +14,13 @@ module Spree
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,
+ store_credit_total: :string, display_store_credit_total: :string,
+ gift_card_total: :string, display_gift_card_total: :string,
+ covered_by_store_credit: :boolean,
total: :string, display_total: :string,
shipping_eq_billing_address: :boolean,
- billing_address: { nullable: true }, shipping_address: { nullable: true }
+ billing_address: { nullable: true }, shipping_address: { nullable: true },
+ gift_card: { nullable: true }
# Override ID to use cart_ prefix
attribute :id do |order|
@@ -33,6 +37,20 @@ module Spree
:delivery_total, :display_delivery_total,
created_at: :iso8601, updated_at: :iso8601
+ attribute :store_credit_total do |order|
+ order.total_applied_store_credit.to_s
+ end
+
+ attribute :display_store_credit_total do |order|
+ order.display_total_applied_store_credit.to_s
+ end
+
+ attributes :gift_card_total, :display_gift_card_total
+
+ attribute :covered_by_store_credit do |order|
+ order.covered_by_store_credit?
+ end
+
attribute :current_step do |order|
order.current_checkout_step
end
@@ -57,6 +75,7 @@ module Spree
one :shipping_address, resource: Spree.api.address_serializer
many :payment_methods, resource: Spree.api.payment_method_serializer
+ one :gift_card, resource: Spree.api.gift_card_serializer
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/customer_serializer.rb b/spree/api/app/serializers/spree/api/v3/customer_serializer.rb
index f89ef73460..86b36c77ef 100644
--- a/spree/api/app/serializers/spree/api/v3/customer_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/customer_serializer.rb
@@ -6,11 +6,24 @@ module Spree
class CustomerSerializer < BaseSerializer
typelize email: :string, first_name: [:string, nullable: true], last_name: [:string, nullable: true],
phone: [:string, nullable: true], accepts_email_marketing: :boolean,
+ available_store_credit_total: :string, display_available_store_credit_total: :string,
default_billing_address: { nullable: true }, default_shipping_address: { nullable: true }
attributes :email, :first_name, :last_name, :phone, :accepts_email_marketing,
created_at: :iso8601, updated_at: :iso8601
+ attribute :available_store_credit_total do |user, params|
+ store = params&.dig(:store) || Spree::Current.store
+ currency = params&.dig(:currency) || Spree::Current.currency || store&.default_currency
+ user.total_available_store_credit(currency, store).to_s
+ end
+
+ attribute :display_available_store_credit_total do |user, params|
+ store = params&.dig(:store) || Spree::Current.store
+ currency = params&.dig(:currency) || Spree::Current.currency || store&.default_currency
+ Spree::Money.new(user.total_available_store_credit(currency, store), currency: currency).to_s
+ end
+
many :addresses, resource: Spree.api.address_serializer
one :bill_address, key: :default_billing_address, resource: Spree.api.address_serializer
one :ship_address, key: :default_shipping_address, resource: Spree.api.address_serializer
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 a9b1253a3e..00bdae063d 100644
--- a/spree/api/app/serializers/spree/api/v3/order_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/order_serializer.rb
@@ -14,8 +14,12 @@ module Spree
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,
+ store_credit_total: :string, display_store_credit_total: :string,
+ gift_card_total: :string, display_gift_card_total: :string,
+ covered_by_store_credit: :boolean,
total: :string, display_total: :string, completed_at: [:string, nullable: true],
- billing_address: { nullable: true }, shipping_address: { nullable: true }
+ billing_address: { nullable: true }, shipping_address: { nullable: true },
+ gift_card: { nullable: true }
attributes :number, :email, :customer_note,
:currency, :locale, :total_quantity,
@@ -27,12 +31,27 @@ module Spree
:delivery_total, :display_delivery_total, :fulfillment_status, :payment_status,
completed_at: :iso8601, created_at: :iso8601, updated_at: :iso8601
+ attribute :store_credit_total do |order|
+ order.total_applied_store_credit.to_s
+ end
+
+ attribute :display_store_credit_total do |order|
+ order.display_total_applied_store_credit.to_s
+ end
+
+ attributes :gift_card_total, :display_gift_card_total
+
+ attribute :covered_by_store_credit do |order|
+ order.covered_by_store_credit?
+ end
+
many :discounts, resource: Spree.api.discount_serializer
many :line_items, key: :items, resource: Spree.api.line_item_serializer
many :fulfillments, resource: Spree.api.fulfillment_serializer
many :payments, resource: Spree.api.payment_serializer
one :billing_address, resource: Spree.api.address_serializer
one :shipping_address, resource: Spree.api.address_serializer
+ one :gift_card, resource: Spree.api.gift_card_serializer
end
end
end
diff --git a/spree/api/config/routes.rb b/spree/api/config/routes.rb
index 367d055a17..2a4a0c66d2 100644
--- a/spree/api/config/routes.rb
+++ b/spree/api/config/routes.rb
@@ -66,6 +66,7 @@ Spree::Core::Engine.add_routes do
resources :addresses, only: [:index, :show, :create, :update, :destroy]
resources :credit_cards, only: [:index, :show, :destroy]
resources :gift_cards, only: [:index, :show]
+ resources :store_credits, only: [:index, :show]
resources :payment_setup_sessions, only: [:create, :show] do
member do
patch :complete
diff --git a/spree/api/lib/spree/api/dependencies.rb b/spree/api/lib/spree/api/dependencies.rb
index b6d2911a4a..3d51cb314e 100644
--- a/spree/api/lib/spree/api/dependencies.rb
+++ b/spree/api/lib/spree/api/dependencies.rb
@@ -170,6 +170,7 @@ module Spree
admin_stock_item_serializer: 'Spree::Api::V3::Admin::StockItemSerializer',
admin_shipment_serializer: 'Spree::Api::V3::Admin::FulfillmentSerializer',
admin_fulfillment_serializer: 'Spree::Api::V3::Admin::FulfillmentSerializer',
+ admin_gift_card_serializer: 'Spree::Api::V3::Admin::GiftCardSerializer',
admin_payment_serializer: 'Spree::Api::V3::Admin::PaymentSerializer',
admin_refund_serializer: 'Spree::Api::V3::Admin::RefundSerializer',
admin_adjustment_serializer: 'Spree::Api::V3::Admin::AdjustmentSerializer',
diff --git a/spree/api/spec/controllers/spree/api/v3/store/customer/store_credits_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/customer/store_credits_controller_spec.rb
new file mode 100644
index 0000000000..482e056e4a
--- /dev/null
+++ b/spree/api/spec/controllers/spree/api/v3/store/customer/store_credits_controller_spec.rb
@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Api::V3::Store::Customer::StoreCreditsController, type: :controller do
+ render_views
+
+ include_context 'API v3 Store'
+
+ let!(:store_credit) { create(:store_credit, user: user, store: store, currency: 'USD', amount: 50) }
+ let!(:other_currency_credit) { create(:store_credit, user: user, store: store, currency: 'EUR', amount: 25) }
+ let!(:other_store_credit) { create(:store_credit, user: create(:user), store: store, currency: 'USD', amount: 100) }
+
+ before do
+ request.headers['X-Spree-Api-Key'] = api_key.token
+ request.headers['Authorization'] = "Bearer #{jwt_token}"
+ end
+
+ describe 'GET #index' do
+ it 'returns store credits for the current user, store and currency' do
+ get :index
+
+ expect(response).to have_http_status(:ok)
+ ids = json_response['data'].map { |sc| sc['id'] }
+ expect(ids).to include(store_credit.prefixed_id)
+ expect(ids).not_to include(other_currency_credit.prefixed_id)
+ expect(ids).not_to include(other_store_credit.prefixed_id)
+ end
+
+ it 'returns store credit attributes' do
+ get :index
+
+ credit = json_response['data'].first
+ expect(credit).to include('id', 'amount', 'amount_used', 'amount_remaining', 'currency')
+ expect(credit).to include('display_amount', 'display_amount_used', 'display_amount_remaining')
+ end
+
+ it 'supports pagination' do
+ get :index, params: { page: 1, limit: 1 }
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['meta']).to include('page', 'count')
+ end
+
+ context 'without authentication' do
+ before { request.headers['Authorization'] = nil }
+
+ it 'returns unauthorized' do
+ get :index
+
+ expect(response).to have_http_status(:unauthorized)
+ end
+ end
+ end
+
+ describe 'GET #show' do
+ it 'returns the store credit' do
+ get :show, params: { id: store_credit.prefixed_id }
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['id']).to eq(store_credit.prefixed_id)
+ expect(json_response['amount']).to be_present
+ end
+
+ it 'returns not found for other user store credit' do
+ get :show, params: { id: other_store_credit.prefixed_id }
+
+ expect(response).to have_http_status(:not_found)
+ end
+
+ it 'returns not found for other currency store credit' do
+ get :show, params: { id: other_currency_credit.prefixed_id }
+
+ expect(response).to have_http_status(:not_found)
+ end
+
+ context 'without authentication' do
+ before { request.headers['Authorization'] = nil }
+
+ it 'returns unauthorized' do
+ get :show, params: { id: store_credit.prefixed_id }
+
+ expect(response).to have_http_status(:unauthorized)
+ end
+ end
+ end
+end
diff --git a/spree/api/spec/integration/spree/api/v3/store/store_credits_customer_spec.rb b/spree/api/spec/integration/spree/api/v3/store/store_credits_customer_spec.rb
new file mode 100644
index 0000000000..d07ba2aa6a
--- /dev/null
+++ b/spree/api/spec/integration/spree/api/v3/store/store_credits_customer_spec.rb
@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'swagger_helper'
+
+RSpec.describe 'Customer Store Credits API', type: :request, swagger_doc: 'api-reference/store.yaml' do
+ include_context 'API v3 Store'
+
+ let!(:store_credit) { create(:store_credit, user: user, store: store, currency: 'USD', amount: 100) }
+
+ path '/api/v3/store/customers/me/store_credits' do
+ get 'List store credits' do
+ tags 'Customers'
+ produces 'application/json'
+ security [api_key: [], bearer_auth: []]
+ description 'Returns store credits for the authenticated customer, filtered by current store and currency. Supports Ransack filtering.'
+
+ sdk_example <<~JS
+ const credits = await client.customer.storeCredits.list({}, {
+ bearerToken: '<token>',
+ })
+ JS
+
+ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
+ parameter name: 'Authorization', in: :header, type: :string, required: true
+ parameter name: :page, in: :query, type: :integer, required: false
+ parameter name: :limit, in: :query, type: :integer, required: false
+ parameter name: :fields, in: :query, type: :string, required: false,
+ description: 'Comma-separated list of fields to include (e.g., amount,currency). id is always included.'
+
+ response '200', 'store credits found' do
+ let(:'x-spree-api-key') { api_key.token }
+ let(:'Authorization') { "Bearer #{jwt_token}" }
+
+ schema type: :object,
+ properties: {
+ data: { type: :array, items: { '$ref' => '#/components/schemas/StoreCredit' } },
+ meta: { '$ref' => '#/components/schemas/PaginationMeta' }
+ }
+
+ run_test! do |response|
+ data = JSON.parse(response.body)
+ expect(data['data']).to be_an(Array)
+ expect(data['data'].first).to include('id', 'amount', 'amount_remaining', 'currency')
+ end
+ end
+
+ response '401', 'unauthorized' do
+ let(:'x-spree-api-key') { api_key.token }
+ let(:'Authorization') { '' }
+
+ schema '$ref' => '#/components/schemas/ErrorResponse'
+
+ run_test!
+ end
+ end
+ end
+
+ path '/api/v3/store/customers/me/store_credits/{id}' do
+ get 'Get a store credit' do
+ tags 'Customers'
+ produces 'application/json'
+ security [api_key: [], bearer_auth: []]
+
+ sdk_example <<~JS
+ const credit = await client.customer.storeCredits.get('credit_abc123', {
+ bearerToken: '<token>',
+ })
+ JS
+
+ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
+ parameter name: 'Authorization', in: :header, type: :string, required: true
+ parameter name: :id, in: :path, type: :string, required: true
+ parameter name: :fields, in: :query, type: :string, required: false,
+ description: 'Comma-separated list of fields to include (e.g., amount,currency). id is always included.'
+
+ response '200', 'store credit found' do
+ let(:'x-spree-api-key') { api_key.token }
+ let(:'Authorization') { "Bearer #{jwt_token}" }
+ let(:id) { store_credit.to_param }
+
+ schema '$ref' => '#/components/schemas/StoreCredit'
+
+ run_test!
+ end
+
+ response '404', 'store credit not found' do
+ let(:'x-spree-api-key') { api_key.token }
+ let(:'Authorization') { "Bearer #{jwt_token}" }
+ let(:id) { 'non-existent' }
+
+ schema '$ref' => '#/components/schemas/ErrorResponse'
+
+ run_test!
+ end
+ end
+ end
+end