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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Fix: Store credit amounts are read exactly instead of as floats (#14873)
Damian Legawiecf71fb8ac5ef8
diff --git a/.changeset/store-credit-amount-string.md b/.changeset/store-credit-amount-string.mdnew file mode 100644index 0000000000..4a6deb983e--- /dev/null+++ b/.changeset/store-credit-amount-string.md@@ -0,0 +1,5 @@+---+"@spree/sdk": minor+---++`carts.storeCredits.apply()` takes the amount as a decimal string (`'10.00'`), like every other money value; a number is no longer accepted.diff --git a/docs/api-reference/store.yaml b/docs/api-reference/store.yamlindex 980b52eafd..fc71388e54 100644--- a/docs/api-reference/store.yaml+++ b/docs/api-reference/store.yaml@@ -5742,7 +5742,7 @@ paths:publishableKey: '<api-key>',})- const cart = await client.carts.storeCredits.apply('cart_abc123', 10.0, {+ const cart = await client.carts.storeCredits.apply('cart_abc123', '10.00', {token: '<token>',})parameters:diff --git a/docs/developer/sdk/store/cart-checkout.mdx b/docs/developer/sdk/store/cart-checkout.mdxindex 4757f9fb75..e8578f1708 100644--- a/docs/developer/sdk/store/cart-checkout.mdx+++ b/docs/developer/sdk/store/cart-checkout.mdx@@ -170,7 +170,7 @@ const options = { spreeToken: cart.token };await client.carts.storeCredits.apply(cartId, undefined, options);// Apply specific amount of store credit-await client.carts.storeCredits.apply(cartId, 25.00, options);+await client.carts.storeCredits.apply(cartId, '25.00', options);// Remove store credit from orderawait client.carts.storeCredits.remove(cartId, options);diff --git a/docs/developer/upgrades/5.6-to-6.0.mdx b/docs/developer/upgrades/5.6-to-6.0.mdxindex c24c4b99fe..acd7cd7547 100644--- a/docs/developer/upgrades/5.6-to-6.0.mdx+++ b/docs/developer/upgrades/5.6-to-6.0.mdx@@ -1089,7 +1089,7 @@ A storefront built on the Store API and `@spree/sdk`, such as the [Spree storefr| `string \| null` where a price or amount is read | Money fields are `null` for guests when the store hides prices | [Money can be null](#money-can-be-null) || A property that "does not exist" in a `…Params` type | Request types now list exactly what the endpoint accepts | [Request types](#request-types-match-the-api) || `ProductSort`, or a filter key | List filters and sort are typed | [List filters and sort](#list-filters-and-sort-are-typed) |-| `number` is not assignable to `string` in a filter or amount | Money is a decimal string everywhere | Send `'20.00'`, not `20` ([Money](#money)) |+| `number` is not assignable to `string` in a filter or amount | Money is a decimal string everywhere | Send `'20.00'`, not `20` ([Money](#money), [store credit](#store-credit-amounts-are-decimal-strings)) |### List filters and sort are typed@@ -1165,6 +1165,16 @@ const country = market.country_codes.find((code) => code === params.country.toUpEvery money field, including `display_*` amounts (a gift card's or store credit's `display_amount_remaining`, a delivery rate's `cost`), is typed `string | null`: it is `null` for a guest when the store hides prices (`prices_hidden`). Handle `null` where you format or add amounts, for example by showing nothing, or a "price on request" label.+### Store credit amounts are decimal strings++`carts.storeCredits.apply()` takes the amount as a decimal string, like every other money value. Leave the amount out to apply as much store credit as the cart can use:++```ts+await client.carts.storeCredits.apply(cartId, '25.00', options) // not 25+```++The endpoint (`POST /carts/:id/store_credits`) now refuses a JSON number with `422 invalid_money_format`, so a storefront that calls the API without the SDK must send a string too.+### Deprecated fields still work until 6.1These Store API fields keep working in 6.0 and are marked `@deprecated` in the SDK types, so editors strike them through. Switch now; they are removed in 6.1:diff --git a/packages/sdk/examples/carts/store-credits-apply.ts b/packages/sdk/examples/carts/store-credits-apply.tsindex 38e1af576b..b0e7450bf5 100644--- a/packages/sdk/examples/carts/store-credits-apply.ts+++ b/packages/sdk/examples/carts/store-credits-apply.ts@@ -6,7 +6,7 @@ const client = createClient({})// region:example-const cart = await client.carts.storeCredits.apply('cart_abc123', 10.0, {+const cart = await client.carts.storeCredits.apply('cart_abc123', '10.00', {token: '<token>',})diff --git a/packages/sdk/src/store-client.ts b/packages/sdk/src/store-client.tsindex 494db3639e..640098d920 100644--- a/packages/sdk/src/store-client.ts+++ b/packages/sdk/src/store-client.ts@@ -757,8 +757,10 @@ export class StoreClient {/*** Apply store credit to the cart* @param cartId - Cart prefixed ID+ * @param amount - How much to apply, as a decimal string (`'10.00'`). Omit it to apply as much+ * as the cart can use.*/- apply: (cartId: string, amount?: number, options?: RequestOptions): Promise<Cart> =>+ apply: (cartId: string, amount?: string, options?: RequestOptions): Promise<Cart> =>this.request<Cart>('POST', `/carts/${cartId}/store_credits`, {...options,body: amount ? { amount } : undefined,diff --git a/packages/sdk/tests/cart.test.ts b/packages/sdk/tests/cart.test.tsindex 7d2ab93af3..70623d7488 100644--- a/packages/sdk/tests/cart.test.ts+++ b/packages/sdk/tests/cart.test.ts@@ -162,7 +162,7 @@ describe('carts', () => {describe('storeCredits', () => {it('applies store credit', async () => {- const result = await client.carts.storeCredits.apply('cart_1', 10, opts)+ const result = await client.carts.storeCredits.apply('cart_1', '10.00', opts)expect(result.id).toBe('cart_1')})diff --git a/spree/api/app/controllers/spree/api/v3/admin/orders/store_credits_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/orders/store_credits_controller.rbindex 3193b57de9..c489392f66 100644--- a/spree/api/app/controllers/spree/api/v3/admin/orders/store_credits_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/orders/store_credits_controller.rb@@ -19,7 +19,7 @@ module Spreewith_order_lock doresult = Spree.store_credit_apply_service.call(order: @parent,- amount: params[:amount].try(:to_f)+ amount: money_param(:amount, @parent.currency))if result.success?diff --git a/spree/api/app/controllers/spree/api/v3/store/carts/store_credits_controller.rb b/spree/api/app/controllers/spree/api/v3/store/carts/store_credits_controller.rbindex 0fe3167ed0..1f182a2450 100644--- a/spree/api/app/controllers/spree/api/v3/store/carts/store_credits_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/store/carts/store_credits_controller.rb@@ -21,7 +21,7 @@ module Spreewith_order_lock doresult = Spree.store_credit_apply_service.call(order: @cart,- amount: params[:amount].try(:to_f)+ amount: money_param(:amount, @cart.currency))if result.success?diff --git a/spree/api/spec/controllers/spree/api/v3/admin/orders/store_credits_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/orders/store_credits_controller_spec.rbindex bb3e9a8a09..7086b14411 100644--- a/spree/api/spec/controllers/spree/api/v3/admin/orders/store_credits_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/admin/orders/store_credits_controller_spec.rb@@ -30,6 +30,15 @@ RSpec.describe Spree::Api::V3::Admin::Orders::StoreCreditsController, type: :conendend+ context 'with an amount in cents' do+ it 'applies it exactly' do+ post :create, params: { order_id: order.prefixed_id, amount: '12.34' }, as: :json++ expect(response).to have_http_status(:created)+ expect(order.reload.payments.store_credits.sum(:amount)).to eq(BigDecimal('12.34'))+ end+ end+context 'when explicit amount exceeds available balance' doit 'caps at the available store credit balance' dopost :create, params: { order_id: order.prefixed_id, amount: '9999.99' }, as: :jsondiff --git a/spree/api/spec/controllers/spree/api/v3/store/carts/store_credits_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/carts/store_credits_controller_spec.rbindex 9c7c910c69..c5fb8e6074 100644--- a/spree/api/spec/controllers/spree/api/v3/store/carts/store_credits_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/store/carts/store_credits_controller_spec.rb@@ -16,13 +16,36 @@ RSpec.describe Spree::Api::V3::Store::Carts::StoreCreditsController, type: :contdescribe 'POST #create' doit 'applies store credit to the cart' do- post :create, params: { cart_id: order.prefixed_id, amount: 10 }+ post :create, params: { cart_id: order.prefixed_id, amount: '10.00' }expect(response).to have_http_status(:ok)expect(json_response['id']).to start_with('cart_')expect(order.reload.payments.store_credits.count).to eq(1)end+ context 'with an amount' do+ it 'applies a decimal string exactly' do+ post :create, params: { cart_id: order.prefixed_id, amount: '5.05' }, as: :json++ expect(response).to have_http_status(:ok)+ expect(order.reload.payments.store_credits.sum(:amount)).to eq(BigDecimal('5.05'))+ end++ it 'refuses a JSON number: money is a decimal string' do+ post :create, params: { cart_id: order.prefixed_id, amount: 5.05 }, as: :json++ expect(response).to have_http_status(:unprocessable_content)+ expect(json_response['error']['code']).to eq('invalid_money_format')+ end++ it 'refuses a localized amount' do+ post :create, params: { cart_id: order.prefixed_id, amount: '10,10' }, as: :json++ expect(response).to have_http_status(:unprocessable_content)+ expect(json_response['error']['code']).to eq('invalid_money_format')+ end+ end+context 'without available store credit' dolet(:user_without_credit) { create(:user) }let!(:order_without_credit) { create(:cart_with_line_items, customer: user_without_credit, store: store) }diff --git a/spree/api/spec/integration/spree/api/v3/store/store_credits_spec.rb b/spree/api/spec/integration/spree/api/v3/store/store_credits_spec.rbindex 218572719e..44c176f6e0 100644--- a/spree/api/spec/integration/spree/api/v3/store/store_credits_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/store/store_credits_spec.rb@@ -32,7 +32,7 @@ RSpec.describe 'Cart Store Credits API', type: :request, swagger_doc: 'api-referlet(:store_credit) { create(:store_credit, customer: user, store: store, amount: 50) }let(:'x-spree-api-key') { api_key.token }let(:'Authorization') { "Bearer #{jwt_token}" }- let(:body) { { amount: 10 } }+ let(:body) { { amount: '10.00' } }before dostore_credit_payment_method