docs(pos): document Discount.amount read behavior from 2026-10 - #4619
docs(pos): document Discount.amount read behavior from 2026-10#4619vctrchu wants to merge 1 commit into
Conversation
Assisted-By: devx/ebf9cf26-03bb-4c3e-9919-a083a362bb2b
|
We detected some changes in |
📝 POS Version Documentation ReminderWe detected changes in If these changes are user-facing and should be documented in the version changelog, please update: If you are making internal changes that don't affect the public API, you can ignore this reminder. |
|
Superseded by #4621 — the 2026-10 release now lives on the 2026-10-rc branch, so the doc change targets that instead of unstable. |
What
Adds TSDoc to
Discount.amounton the POS cart types documenting the read behavior that ships with API version 2026-10: reading a manual discount from the cart returns the value that was applied (e.g.10for 10%), matching writes, so discounts can be echoed throughbulkCartUpdatelosslessly. Includes the POS app version caveat for older clients.Why
Part of the fix for shop/issues-retail#33093: before 2026-10, reads return the calculated monetary total while writes take the applied value, so read-modify-write cycles silently corrupt percentage discounts. The behavior change is implemented in Shopify/extensibility#1657 (host, version-gated) and shop/world#997169 (POS emits the raw value).
Reported in https://community.shopify.dev/t/36265 and https://community.shopify.dev/t/36171.
Companion doc correction for the released 2026-07 branch: see the
2026-07_pos_discount_amount_doc_fixPR.