@spree/docs 0.1.268 → 0.1.269
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -399,6 +399,8 @@ Store Credits and Gift Cards work differently at checkout:
|
|
|
399
399
|
- **Store Credits** - Require a customer account; applied from the customer's balance
|
|
400
400
|
- **Gift Cards** - Can be used by anyone (guests included); applied directly to the order via code
|
|
401
401
|
|
|
402
|
+
Both are applied before the customer chooses how to pay, and neither appears among the cart's payment methods. An order uses one or the other, never both. A gift card covers as much of the total as its balance allows and keeps up as the total changes. See the [cart & checkout SDK guide](../sdk/store/cart-checkout.md) for the calls.
|
|
403
|
+
|
|
402
404
|
### Checkout Flow
|
|
403
405
|
|
|
404
406
|
```mermaid
|
|
@@ -77,6 +77,8 @@ const cart = await client.carts.giftCards.apply(cartId, 'GC-ABCD-1234', options)
|
|
|
77
77
|
await client.carts.giftCards.remove(cartId, 'gc_abc123', options);
|
|
78
78
|
```
|
|
79
79
|
|
|
80
|
+
A gift card pays as much of the total as its balance allows, and its share keeps up when delivery, discounts or tax change the total. A cart can use a gift card or store credit, not both.
|
|
81
|
+
|
|
80
82
|
### Fees and Duties
|
|
81
83
|
|
|
82
84
|
A cart may carry charges that are neither a product price nor tax: gift wrapping, a handling charge, a cash-on-delivery surcharge, or an import duty on a cross-border order. Each is a [fee](../../core-concepts/fees.md) on the cart, and the storefront should show every one of them before the customer pays.
|
|
@@ -174,6 +176,8 @@ await client.carts.storeCredits.apply(cartId, 25.00, options);
|
|
|
174
176
|
await client.carts.storeCredits.remove(cartId, options);
|
|
175
177
|
```
|
|
176
178
|
|
|
179
|
+
Store credit is a balance, not one of the cart's `payment_methods`: apply it here, then collect whatever `amount_due` is left with a payment method. It can't be combined with a gift card on the same cart.
|
|
180
|
+
|
|
177
181
|
### Totals
|
|
178
182
|
|
|
179
183
|
The cart and order responses break the amount the customer pays into these totals. Each has a raw string value and a `display_` twin formatted in the cart's currency.
|