docs: fix total descriptions across docs (#14366)

This commit is contained in:
Shahed Nasser
2025-12-19 15:31:28 +02:00
committed by GitHub
parent 365468d3da
commit 797878af26
33 changed files with 1063 additions and 815 deletions

View File

@@ -89,59 +89,77 @@ properties:
original_item_total:
type: number
title: original_item_total
description: The cart's original item total.
description: >-
The sum of all line items' original totals before discounts, including
taxes.
original_item_subtotal:
type: number
title: original_item_subtotal
description: The cart's original item subtotal.
description: >-
The sum of all line items' original subtotals before discounts, excluding
taxes.
original_item_tax_total:
type: number
title: original_item_tax_total
description: The cart's original item tax total.
description: The sum of all line items' original tax totals before discounts.
item_total:
type: number
title: item_total
description: The cart's item total.
description: The sum of all line items' totals after discounts, including taxes.
item_subtotal:
type: number
title: item_subtotal
description: The cart's item subtotal.
description: The sum of all line items' subtotals before discounts, excluding taxes.
item_tax_total:
type: number
title: item_tax_total
description: The cart's item tax total.
description: The sum of all line items' tax totals after discounts.
original_total:
type: number
title: original_total
description: The cart's original total.
description: >-
The cart's total before discounts, including taxes. Calculated as the sum
of `original_item_total` and `original_shipping_total`.
original_subtotal:
type: number
title: original_subtotal
description: The cart's original subtotal.
description: >-
The cart's subtotal before discounts, excluding taxes. Calculated as the
sum of `original_item_subtotal` and `original_shipping_subtotal`.
original_tax_total:
type: number
title: original_tax_total
description: The cart's original tax total.
description: >-
The cart's tax total before discounts. Calculated as the sum of
`original_item_tax_total` and `original_shipping_tax_total`.
total:
type: number
title: total
description: The cart's total.
description: The cart's final total after discounts and credit lines, including taxes.
subtotal:
type: number
title: subtotal
description: The cart's subtotal.
description: >-
The cart's subtotal before discounts, excluding taxes. Calculated as the
sum of `item_subtotal` and `shipping_subtotal`.
tax_total:
type: number
title: tax_total
description: The cart's tax total.
description: >-
The cart's tax total after discounts. Calculated as the sum of
`item_tax_total` and `shipping_tax_total`.
discount_total:
type: number
title: discount_total
description: The cart's discount total.
description: >-
The total amount of discounts applied to the cart, including the tax
portion of discounts.
discount_tax_total:
type: number
title: discount_tax_total
description: The cart's discount tax total.
description: >-
The total amount of discounts applied to the cart's tax. Represents the
tax portion of discounts.
gift_card_total:
type: number
title: gift_card_total
@@ -153,24 +171,30 @@ properties:
shipping_total:
type: number
title: shipping_total
description: The cart's shipping total.
description: The sum of all shipping methods' totals after discounts, including taxes.
shipping_subtotal:
type: number
title: shipping_subtotal
description: The cart's shipping subtotal.
description: >-
The sum of all shipping methods' subtotals before discounts, excluding
taxes.
shipping_tax_total:
type: number
title: shipping_tax_total
description: The cart's shipping tax total.
description: The sum of all shipping methods' tax totals after discounts.
original_shipping_total:
type: number
title: original_shipping_total
description: The cart's original shipping total.
description: >-
The sum of all shipping methods' original totals before discounts,
including taxes.
original_shipping_subtotal:
type: number
title: original_shipping_subtotal
description: The cart's original shipping subtotal.
description: >-
The sum of all shipping methods' original subtotals before discounts,
excluding taxes.
original_shipping_tax_total:
type: number
title: original_shipping_tax_total
description: The cart's original shipping tax total.
description: The sum of all shipping methods' original tax totals before discounts.