Skip to content

docs: fix total descriptions across docs - #14366

Merged
shahednasser merged 1 commit into
developfrom
docs/fix-totals
Dec 19, 2025
Merged

docs: fix total descriptions across docs#14366
shahednasser merged 1 commit into
developfrom
docs/fix-totals

Conversation

@shahednasser

@shahednasser shahednasser commented Dec 19, 2025

Copy link
Copy Markdown
Member

Fixed cart and order total descriptions across OAS, references, and guides.

Closes DX-2325


Note

Standardizes and clarifies cart/order total field descriptions across admin/store schemas, generated OAS, and docs, specifying pre/post-discount semantics, tax inclusion, and aggregation formulas.

  • API Schemas (Admin/Store):
    • Refine descriptions for totals in BaseCart, BaseOrder, line items, and shipping methods (e.g., total, subtotal, tax_total, original_*, item_*, shipping_*).
    • Specify pre/post-discount semantics, tax inclusion/exclusion, and explicit aggregation formulas (e.g., sums of item/shipping components); clarify discount and discount tax fields.
  • OpenAPI (full) + Generated Types:
    • Sync updated descriptions in openapi.full.yaml and generated oas-output TypeScript schema docs.
  • Guides/Resources:
    • Update cart and order totals guides and storefront tables to the new definitions; add clarifications for discount_subtotal and credit line totals and how subtotals/totals are computed.

Written by Cursor Bugbot for commit d7e4a67. This will update automatically on new commits. Configure here.

@shahednasser
shahednasser requested a review from a team as a code owner December 19, 2025 12:12
@vercel

vercel Bot commented Dec 19, 2025

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
api-reference-v2 Ready Ready Preview, Comment Dec 19, 2025 0:17am
resources-docs Ready Ready Preview, Comment Dec 19, 2025 0:17am
6 Skipped Deployments
Project Deployment Review Updated (UTC)
api-reference Ignored Ignored Dec 19, 2025 0:17am
cloud-docs Ignored Ignored Dec 19, 2025 0:17am
docs-ui Ignored Ignored Dec 19, 2025 0:17am
docs-v2 Ignored Ignored Dec 19, 2025 0:17am
medusa-docs Ignored Ignored Dec 19, 2025 0:17am
user-guide Ignored Ignored Dec 19, 2025 0:17am

@changeset-bot

changeset-bot Bot commented Dec 19, 2025

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: d7e4a67

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant