Skip to content

docs(pos): correct Discount.amount read behavior for 2026-07 - #4620

Open
vctrchu wants to merge 1 commit into
2026-07from
2026-07_pos_discount_amount_doc_fix
Open

docs(pos): correct Discount.amount read behavior for 2026-07#4620
vctrchu wants to merge 1 commit into
2026-07from
2026-07_pos_discount_amount_doc_fix

Conversation

@vctrchu

@vctrchu vctrchu commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

What

Corrects the Discount.amount TSDoc on the POS cart types for the released 2026-07 API version: reading a discount from the cart returns the calculated monetary total in this field, not the value that was applied. The previous doc claimed reads return the percentage value, which is not what this version does (shop/issues-retail#33093, reported in https://community.shopify.dev/t/36265 and https://community.shopify.dev/t/36171).

Also warns that echoing a read discount back through bulkCartUpdate does not preserve it in this version, and points to 2026-10 where reads match writes (Shopify/extensibility#1657, shop/world#997169).

Older released branches have the same behavior; happy to cherry-pick this doc note to them if that's the convention.

Assisted-By: devx/ebf9cf26-03bb-4c3e-9919-a083a362bb2b
@github-actions

Copy link
Copy Markdown
Contributor

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.

@github-actions github-actions Bot added the needs-rc-port PR against a stable branch awaiting forward-port to the current RC label Aug 14, 2026
@github-actions

Copy link
Copy Markdown
Contributor

This PR targets a stable release branch (2026-07). Once merged, the change typically also needs to be forward-ported to 2026-10-rc so it ships in the next release.

When you open the forward-port PR, include a line like this in its body so the needs-rc-port label gets removed automatically when that PR merges:

Forward-port of #4620

Accepted formats (comma-separated for multiple):

  • #4620
  • GH-4620
  • 4620
  • https://github.com/Shopify/ui-extensions/pull/4620

If a forward-port isn't needed (e.g., the change is stable-only), you can remove the needs-rc-port label manually.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-rc-port PR against a stable branch awaiting forward-port to the current RC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant