docs: fix total descriptions across docs (#14366)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
365468d3da
commit
797878af26
33 files changed
+1063
-815
No files matched your search
@@ -89,59 +89,77 @@ properties:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
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:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
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:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
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:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The cart's item total.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The cart's item subtotal.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The cart's item tax total.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
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:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
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:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
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:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The cart's total.
|
description: The cart's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
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:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
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:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
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:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
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:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -153,24 +171,30 @@ properties:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The cart's shipping total.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The cart's shipping subtotal.
|
description: >-
|
||||||
|
The sum of all shipping methods' subtotals before discounts, excluding
|
||||||
|
taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
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:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
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:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
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:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
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.
|
||||||
@@ -143,44 +143,48 @@ properties:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The item's original total.
|
description: The line item's original total before discounts, including taxes.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The item's original subtotal.
|
description: The line item's original subtotal before discounts, excluding taxes.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The item's original tax total.
|
description: The line item's original tax total before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The item's item total.
|
description: The line item's total after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The item's item subtotal.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The item's item tax total.
|
description: The line item's tax total after discounts.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The item's total.
|
description: The line item's total after discounts, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The item's subtotal.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The item's tax total.
|
description: The line item's tax total after discounts.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The item's discount total.
|
description: >-
|
||||||
|
The total amount of discounts applied to the line item, including the tax
|
||||||
|
portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The item's discount tax total.
|
description: >-
|
||||||
|
The total amount of discounts applied to the line item's tax. Represents
|
||||||
|
the tax portion of discounts.
|
||||||
@@ -75,36 +75,36 @@ properties:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The shipping method's total including taxes, excluding promotions.
|
description: The shipping method's original total before discounts, including taxes.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The shipping method's total excluding taxes, including promotions.
|
description: The shipping method's original subtotal before discounts, excluding taxes.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: >-
|
description: The shipping method's original tax total before discounts.
|
||||||
The total taxes applied on the shipping method's amount including
|
|
||||||
promotions.
|
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The shipping method's total amount including taxes and promotions.
|
description: The shipping method's total after discounts, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The shipping method's total amount excluding taxes, including promotions.
|
description: The shipping method's subtotal before discounts, excluding taxes.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: >-
|
description: The shipping method's tax total after discounts.
|
||||||
The total taxes applied on the shipping method's amount including
|
|
||||||
promotions.
|
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The total amount discounted.
|
description: >-
|
||||||
|
The total amount of discounts applied to the shipping method, including
|
||||||
|
the tax portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The taxes applied on the discounted amount.
|
description: >-
|
||||||
|
The total amount of discounts applied to the shipping method's tax.
|
||||||
|
Represents the tax portion of discounts.
|
||||||
@@ -152,59 +152,77 @@ properties:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
title: original_item_total
|
||||||
description: The total of the order's items including taxes, excluding promotions.
|
description: >-
|
||||||
|
The sum of all line items' original totals before discounts, including
|
||||||
|
taxes.
|
||||||
original_item_subtotal:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
title: original_item_subtotal
|
||||||
description: The total of the order's items excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all line items' original subtotals before discounts, excluding
|
||||||
|
taxes.
|
||||||
original_item_tax_total:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
title: original_item_tax_total
|
||||||
description: The tax total of the order's items excluding promotions.
|
description: The sum of all line items' original tax totals before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The total of the order's items including taxes and promotions.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The total of the order's items excluding taxes, including promotions.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The tax total of the order's items including promotions.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The order's total excluding promotions, including taxes.
|
description: >-
|
||||||
|
The order's total before discounts, including taxes. Calculated as the sum
|
||||||
|
of `original_item_total` and `original_shipping_total`.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The order's subtotal before discounts, excluding taxes. Calculated as the
|
||||||
|
sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The order's tax total, excluding promotions.
|
description: >-
|
||||||
|
The order's tax total before discounts. Calculated as the sum of
|
||||||
|
`original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The order's total including taxes and promotions.
|
description: The order's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The order's subtotal before discounts, excluding taxes. Calculated as the
|
||||||
|
sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The order's tax total including promotions.
|
description: >-
|
||||||
|
The order's tax total after discounts. Calculated as the sum of
|
||||||
|
`item_tax_total` and `shipping_tax_total`.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The order's discount or promotions total.
|
description: >-
|
||||||
|
The total amount of discounts applied to the order, including the tax
|
||||||
|
portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The tax total of order's discount or promotion.
|
description: >-
|
||||||
|
The total amount of discounts applied to the order's tax. Represents the
|
||||||
|
tax portion of discounts.
|
||||||
gift_card_total:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -216,27 +234,33 @@ properties:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The order's shipping total including taxes and promotions.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' subtotals before discounts, excluding
|
||||||
|
taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
title: shipping_tax_total
|
||||||
description: The tax total of the order's shipping.
|
description: The sum of all shipping methods' tax totals after discounts.
|
||||||
original_shipping_total:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
title: original_shipping_total
|
||||||
description: The order's shipping total including taxes, excluding promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' original totals before discounts,
|
||||||
|
including taxes.
|
||||||
original_shipping_subtotal:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
title: original_shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' original subtotals before discounts,
|
||||||
|
excluding taxes.
|
||||||
original_shipping_tax_total:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
title: original_shipping_tax_total
|
||||||
description: The tax total of the order's shipping excluding promotions.
|
description: The sum of all shipping methods' original tax totals before discounts.
|
||||||
status:
|
status:
|
||||||
type: string
|
type: string
|
||||||
title: status
|
title: status
|
||||||
@@ -244,15 +268,21 @@ properties:
|
|||||||
credit_line_total:
|
credit_line_total:
|
||||||
type: number
|
type: number
|
||||||
title: credit_line_total
|
title: credit_line_total
|
||||||
description: The order's credit line total.
|
description: >-
|
||||||
|
The total amount of credit lines applied to the order, including taxes.
|
||||||
|
Subtracted from the final total.
|
||||||
item_discount_total:
|
item_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_discount_total
|
title: item_discount_total
|
||||||
description: The total discount amount applied on the order's items.
|
description: >-
|
||||||
|
The sum of all discounts applied to line items, including the tax portion
|
||||||
|
of discounts.
|
||||||
shipping_discount_total:
|
shipping_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_discount_total
|
title: shipping_discount_total
|
||||||
description: The total discount amount applied on the order's shipping.
|
description: >-
|
||||||
|
The sum of all discounts applied to shipping methods, including the tax
|
||||||
|
portion of discounts.
|
||||||
custom_display_id:
|
custom_display_id:
|
||||||
type: string
|
type: string
|
||||||
title: custom_display_id
|
title: custom_display_id
|
||||||
|
|||||||
@@ -166,47 +166,51 @@ properties:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The item's total including taxes, excluding promotions.
|
description: The line item's original total before discounts, including taxes.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The item's total excluding taxes, including promotions.
|
description: The line item's original subtotal before discounts, excluding taxes.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The total taxes of the item, excluding promotions.
|
description: The line item's original tax total before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The total taxes of the item, including promotions.
|
description: The line item's total after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The item's total excluding taxes, including promotions.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The total taxes of the item, including promotions.
|
description: The line item's tax total after discounts.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The item's total, including taxes and promotions.
|
description: The line item's total after discounts, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The item's subtotal excluding taxes, including promotions.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The tax total of the item including promotions.
|
description: The line item's tax total after discounts.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The total discount amount of the item.
|
description: >-
|
||||||
|
The total amount of discounts applied to the line item, including the tax
|
||||||
|
portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The total taxes applied on the discounted amount.
|
description: >-
|
||||||
|
The total amount of discounts applied to the line item's tax. Represents
|
||||||
|
the tax portion of discounts.
|
||||||
refundable_total:
|
refundable_total:
|
||||||
type: number
|
type: number
|
||||||
title: refundable_total
|
title: refundable_total
|
||||||
|
|||||||
@@ -94,59 +94,77 @@ properties:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
title: original_item_total
|
||||||
description: The cart items' total including taxes, excluding promotions.
|
description: >-
|
||||||
|
The sum of all line items' original totals before discounts, including
|
||||||
|
taxes.
|
||||||
original_item_subtotal:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
title: original_item_subtotal
|
||||||
description: The cart items' total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all line items' original subtotals before discounts, excluding
|
||||||
|
taxes.
|
||||||
original_item_tax_total:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
title: original_item_tax_total
|
||||||
description: The cart items' tax total excluding promotions.
|
description: The sum of all line items' original tax totals before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The cart items' total including taxes and promotions.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The cart items' total excluding taxes, including promotions.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The cart items' tax total including promotions.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The cart's total including taxes, excluding promotions.
|
description: >-
|
||||||
|
The cart's total before discounts, including taxes. Calculated as the sum
|
||||||
|
of `original_item_total` and `original_shipping_total`.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The cart's total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The cart's subtotal before discounts, excluding taxes. Calculated as the
|
||||||
|
sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The cart's tax total excluding promotions.
|
description: >-
|
||||||
|
The cart's tax total before discounts. Calculated as the sum of
|
||||||
|
`original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The cart's total including taxes and promotions.
|
description: The cart's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The cart's total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The cart's subtotal before discounts, excluding taxes. Calculated as the
|
||||||
|
sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The cart's tax total including promotions.
|
description: >-
|
||||||
|
The cart's tax total after discounts. Calculated as the sum of
|
||||||
|
`item_tax_total` and `shipping_tax_total`.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
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:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The tax total applied on the discounted amount.
|
description: >-
|
||||||
|
The total amount of discounts applied to the cart's tax. Represents the
|
||||||
|
tax portion of discounts.
|
||||||
gift_card_total:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -158,27 +176,33 @@ properties:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The cart's shipping total including taxes and promotions.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The cart's shipping total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' subtotals before discounts, excluding
|
||||||
|
taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
title: shipping_tax_total
|
||||||
description: The total taxes applied on the cart's shipping amount.
|
description: The sum of all shipping methods' tax totals after discounts.
|
||||||
original_shipping_total:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
title: original_shipping_total
|
||||||
description: The cart's shipping total including taxes, excluding promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' original totals before discounts,
|
||||||
|
including taxes.
|
||||||
original_shipping_subtotal:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
title: original_shipping_subtotal
|
||||||
description: The cart's shipping total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' original subtotals before discounts,
|
||||||
|
excluding taxes.
|
||||||
original_shipping_tax_total:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
title: original_shipping_tax_total
|
||||||
description: The total taxes applied on the cart's shipping amount.
|
description: The sum of all shipping methods' original tax totals before discounts.
|
||||||
promotions:
|
promotions:
|
||||||
type: array
|
type: array
|
||||||
description: The cart's promotions.
|
description: The cart's promotions.
|
||||||
|
|||||||
@@ -288,31 +288,33 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: >-
|
description: >-
|
||||||
The item's total including taxes, excluding promotions. This field is only
|
The line item's original total before discounts, including taxes. This
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
field is only available if you expand the `items.*` relation. Learn more
|
||||||
|
in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: >-
|
description: >-
|
||||||
The item's total excluding taxes, including promotions. This field is only
|
The line item's original subtotal before discounts, excluding taxes. This
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
field is only available if you expand the `items.*` relation. Learn more
|
||||||
|
in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: >-
|
description: >-
|
||||||
The total taxes of the item excluding promotions. This field is only
|
The line item's original tax total before discounts. This field is only
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: item_total
|
||||||
description: >-
|
description: >-
|
||||||
The item's total including taxes and promotions. This field is only
|
The line item's total after discounts, including taxes. This field is only
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
@@ -320,23 +322,24 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: >-
|
description: >-
|
||||||
The item's total excluding taxes, including promotions. This field is only
|
The line item's subtotal before discounts, excluding taxes. This field is
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
only available if you expand the `items.*` relation. Learn more in the
|
||||||
|
[Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: >-
|
description: >-
|
||||||
The total taxes of the item including promotions. This field is only
|
The line item's tax total after discounts. This field is only available if
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
you expand the `items.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: >-
|
description: >-
|
||||||
The item's total including taxes and promotions. This field is only
|
The line item's total after discounts, including taxes. This field is only
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
@@ -344,31 +347,34 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: >-
|
description: >-
|
||||||
The item's total excluding taxes, including promotions. This field is only
|
The line item's subtotal before discounts, excluding taxes. This field is
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
only available if you expand the `items.*` relation. Learn more in the
|
||||||
|
[Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: >-
|
description: >-
|
||||||
The total taxes of the item including promotions. This field is only
|
The line item's tax total after discounts. This field is only available if
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
you expand the `items.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: >-
|
description: >-
|
||||||
The total discount of the item. This field is only available if you expand
|
The total amount of discounts applied to the line item, including the tax
|
||||||
the `items.*` relation. Learn more in the [Cart
|
portion of discounts. This field is only available if you expand the
|
||||||
|
`items.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: >-
|
description: >-
|
||||||
The total taxes applied on the discounted amount. This field is only
|
The total amount of discounts applied to the line item's tax. Represents
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
the tax portion of discounts. This field is only available if you expand
|
||||||
|
the `items.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
+23
-21
@@ -214,61 +214,62 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: >-
|
description: >-
|
||||||
The shipping method's total including taxes, excluding promotions. This
|
The shipping method's original total before discounts, including taxes.
|
||||||
field is only available if you expand the `shipping_methods.*` relation.
|
This field is only available if you expand the `shipping_methods.*`
|
||||||
Learn more in the [Cart
|
relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: >-
|
description: >-
|
||||||
The shipping method's total excluding taxes, including promotions. This
|
The shipping method's original subtotal before discounts, excluding taxes.
|
||||||
field is only available if you expand the `shipping_methods.*` relation.
|
This field is only available if you expand the `shipping_methods.*`
|
||||||
Learn more in the [Cart
|
relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: >-
|
description: >-
|
||||||
The total taxes applied on the shipping method's amount including
|
The shipping method's original tax total before discounts. This field is
|
||||||
promotions. This field is only available if you expand the
|
only available if you expand the `shipping_methods.*` relation. Learn more
|
||||||
`shipping_methods.*` relation. Learn more in the [Cart
|
in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: >-
|
description: >-
|
||||||
The shipping method's total amount including taxes and promotions. This
|
The shipping method's total after discounts, including taxes. This field
|
||||||
field is only available if you expand the `shipping_methods.*` relation.
|
is only available if you expand the `shipping_methods.*` relation. Learn
|
||||||
Learn more in the [Cart
|
more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: >-
|
description: >-
|
||||||
The shipping method's total amount excluding taxes, including promotions.
|
The shipping method's subtotal before discounts, excluding taxes. This
|
||||||
This field is only available if you expand the `shipping_methods.*`
|
field is only available if you expand the `shipping_methods.*` relation.
|
||||||
relation. Learn more in the [Cart
|
Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: >-
|
description: >-
|
||||||
The total taxes applied on the shipping method's amount including
|
The shipping method's tax total after discounts. This field is only
|
||||||
promotions. This field is only available if you expand the
|
available if you expand the `shipping_methods.*` relation. Learn more in
|
||||||
`shipping_methods.*` relation. Learn more in the [Cart
|
the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: >-
|
description: >-
|
||||||
The total amount discounted. This field is only available if you expand
|
The total amount of discounts applied to the shipping method, including
|
||||||
|
the tax portion of discounts. This field is only available if you expand
|
||||||
the `shipping_methods.*` relation. Learn more in the [Cart
|
the `shipping_methods.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
@@ -276,7 +277,8 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: >-
|
description: >-
|
||||||
The taxes applied on the discounted amount. This field is only available
|
The total amount of discounts applied to the shipping method's tax.
|
||||||
if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
Represents the tax portion of discounts. This field is only available if
|
||||||
|
you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
@@ -143,59 +143,77 @@ properties:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
title: original_item_total
|
||||||
description: The order items' total including taxes, excluding promotions.
|
description: >-
|
||||||
|
The sum of all line items' original totals before discounts, including
|
||||||
|
taxes.
|
||||||
original_item_subtotal:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
title: original_item_subtotal
|
||||||
description: The order items' total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all line items' original subtotals before discounts, excluding
|
||||||
|
taxes.
|
||||||
original_item_tax_total:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
title: original_item_tax_total
|
||||||
description: The total taxes applied on the order items, excluding promotions.
|
description: The sum of all line items' original tax totals before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The order items' total including taxes and promotions.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The order items' total excluding taxes, including promotions.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The total taxes applied on the order's items, including promotions.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The order's total including taxes, excluding promotions.
|
description: >-
|
||||||
|
The order's total before discounts, including taxes. Calculated as the sum
|
||||||
|
of `original_item_total` and `original_shipping_total`.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The order's subtotal before discounts, excluding taxes. Calculated as the
|
||||||
|
sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The total taxes of the order excluding promotions.
|
description: >-
|
||||||
|
The order's tax total before discounts. Calculated as the sum of
|
||||||
|
`original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The order's total including taxes and promotions.
|
description: The order's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The order's subtotal before discounts, excluding taxes. Calculated as the
|
||||||
|
sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The tax totals of the order including promotions.
|
description: >-
|
||||||
|
The order's tax total after discounts. Calculated as the sum of
|
||||||
|
`item_tax_total` and `shipping_tax_total`.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The order's discount total.
|
description: >-
|
||||||
|
The total amount of discounts applied to the order, including the tax
|
||||||
|
portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The total taxes applied on the discounted amount.
|
description: >-
|
||||||
|
The total amount of discounts applied to the order's tax. Represents the
|
||||||
|
tax portion of discounts.
|
||||||
gift_card_total:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -207,27 +225,33 @@ properties:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The order's shipping total including taxes and promotions.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' subtotals before discounts, excluding
|
||||||
|
taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
title: shipping_tax_total
|
||||||
description: The total taxes of the order's shipping including promotions.
|
description: The sum of all shipping methods' tax totals after discounts.
|
||||||
original_shipping_total:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
title: original_shipping_total
|
||||||
description: The order's shipping total including taxes, excluding promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' original totals before discounts,
|
||||||
|
including taxes.
|
||||||
original_shipping_subtotal:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
title: original_shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' original subtotals before discounts,
|
||||||
|
excluding taxes.
|
||||||
original_shipping_tax_total:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
title: original_shipping_tax_total
|
||||||
description: The total taxes of the order's shipping excluding promotions.
|
description: The sum of all shipping methods' original tax totals before discounts.
|
||||||
customer:
|
customer:
|
||||||
$ref: ./StoreCustomer.yaml
|
$ref: ./StoreCustomer.yaml
|
||||||
transactions:
|
transactions:
|
||||||
@@ -242,15 +266,21 @@ properties:
|
|||||||
credit_line_total:
|
credit_line_total:
|
||||||
type: number
|
type: number
|
||||||
title: credit_line_total
|
title: credit_line_total
|
||||||
description: The order's credit line total.
|
description: >-
|
||||||
|
The total amount of credit lines applied to the order, including taxes.
|
||||||
|
Subtracted from the final total.
|
||||||
item_discount_total:
|
item_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_discount_total
|
title: item_discount_total
|
||||||
description: The total discount amount applied on the order's items.
|
description: >-
|
||||||
|
The sum of all discounts applied to line items, including the tax portion
|
||||||
|
of discounts.
|
||||||
shipping_discount_total:
|
shipping_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_discount_total
|
title: shipping_discount_total
|
||||||
description: The total discount amount applied on the order's shipping.
|
description: >-
|
||||||
|
The sum of all discounts applied to shipping methods, including the tax
|
||||||
|
portion of discounts.
|
||||||
custom_display_id:
|
custom_display_id:
|
||||||
type: string
|
type: string
|
||||||
title: custom_display_id
|
title: custom_display_id
|
||||||
|
|||||||
@@ -83900,59 +83900,59 @@ components:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
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:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
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:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
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:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The cart's item total.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The cart's item subtotal.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The cart's item tax total.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
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:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
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:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
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:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The cart's total.
|
description: The cart's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
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:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
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:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
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:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
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:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -83964,27 +83964,27 @@ components:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The cart's shipping total.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The cart's shipping subtotal.
|
description: The sum of all shipping methods' subtotals before discounts, excluding taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
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:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
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:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
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:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
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.
|
||||||
BaseCartAddress:
|
BaseCartAddress:
|
||||||
type: object
|
type: object
|
||||||
description: The cart's shipping address.
|
description: The cart's shipping address.
|
||||||
@@ -84135,47 +84135,47 @@ components:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The item's original total.
|
description: The line item's original total before discounts, including taxes.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The item's original subtotal.
|
description: The line item's original subtotal before discounts, excluding taxes.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The item's original tax total.
|
description: The line item's original tax total before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The item's item total.
|
description: The line item's total after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The item's item subtotal.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The item's item tax total.
|
description: The line item's tax total after discounts.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The item's total.
|
description: The line item's total after discounts, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The item's subtotal.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The item's tax total.
|
description: The line item's tax total after discounts.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The item's discount total.
|
description: The total amount of discounts applied to the line item, including the tax portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The item's discount tax total.
|
description: The total amount of discounts applied to the line item's tax. Represents the tax portion of discounts.
|
||||||
BaseCartShippingMethod:
|
BaseCartShippingMethod:
|
||||||
type: object
|
type: object
|
||||||
description: A cart's shipping method.
|
description: A cart's shipping method.
|
||||||
@@ -84251,35 +84251,35 @@ components:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The shipping method's total including taxes, excluding promotions.
|
description: The shipping method's original total before discounts, including taxes.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The shipping method's total excluding taxes, including promotions.
|
description: The shipping method's original subtotal before discounts, excluding taxes.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The total taxes applied on the shipping method's amount including promotions.
|
description: The shipping method's original tax total before discounts.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The shipping method's total amount including taxes and promotions.
|
description: The shipping method's total after discounts, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The shipping method's total amount excluding taxes, including promotions.
|
description: The shipping method's subtotal before discounts, excluding taxes.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The total taxes applied on the shipping method's amount including promotions.
|
description: The shipping method's tax total after discounts.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The total amount discounted.
|
description: The total amount of discounts applied to the shipping method, including the tax portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The taxes applied on the discounted amount.
|
description: The total amount of discounts applied to the shipping method's tax. Represents the tax portion of discounts.
|
||||||
BaseClaimItem:
|
BaseClaimItem:
|
||||||
type: object
|
type: object
|
||||||
description: The claim item's details.
|
description: The claim item's details.
|
||||||
@@ -84742,59 +84742,59 @@ components:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
title: original_item_total
|
||||||
description: The total of the order's items including taxes, excluding promotions.
|
description: The sum of all line items' original totals before discounts, including taxes.
|
||||||
original_item_subtotal:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
title: original_item_subtotal
|
||||||
description: The total of the order's items excluding taxes, including promotions.
|
description: The sum of all line items' original subtotals before discounts, excluding taxes.
|
||||||
original_item_tax_total:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
title: original_item_tax_total
|
||||||
description: The tax total of the order's items excluding promotions.
|
description: The sum of all line items' original tax totals before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The total of the order's items including taxes and promotions.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The total of the order's items excluding taxes, including promotions.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The tax total of the order's items including promotions.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The order's total excluding promotions, including taxes.
|
description: The order's total before discounts, including taxes. Calculated as the sum of `original_item_total` and `original_shipping_total`.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: The order's subtotal before discounts, excluding taxes. Calculated as the sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The order's tax total, excluding promotions.
|
description: The order's tax total before discounts. Calculated as the sum of `original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The order's total including taxes and promotions.
|
description: The order's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: The order's subtotal before discounts, excluding taxes. Calculated as the sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The order's tax total including promotions.
|
description: The order's tax total after discounts. Calculated as the sum of `item_tax_total` and `shipping_tax_total`.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The order's discount or promotions total.
|
description: The total amount of discounts applied to the order, including the tax portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The tax total of order's discount or promotion.
|
description: The total amount of discounts applied to the order's tax. Represents the tax portion of discounts.
|
||||||
gift_card_total:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -84806,27 +84806,27 @@ components:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The order's shipping total including taxes and promotions.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: The sum of all shipping methods' subtotals before discounts, excluding taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
title: shipping_tax_total
|
||||||
description: The tax total of the order's shipping.
|
description: The sum of all shipping methods' tax totals after discounts.
|
||||||
original_shipping_total:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
title: original_shipping_total
|
||||||
description: The order's shipping total including taxes, excluding promotions.
|
description: The sum of all shipping methods' original totals before discounts, including taxes.
|
||||||
original_shipping_subtotal:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
title: original_shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: The sum of all shipping methods' original subtotals before discounts, excluding taxes.
|
||||||
original_shipping_tax_total:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
title: original_shipping_tax_total
|
||||||
description: The tax total of the order's shipping excluding promotions.
|
description: The sum of all shipping methods' original tax totals before discounts.
|
||||||
status:
|
status:
|
||||||
type: string
|
type: string
|
||||||
title: status
|
title: status
|
||||||
@@ -84834,15 +84834,15 @@ components:
|
|||||||
credit_line_total:
|
credit_line_total:
|
||||||
type: number
|
type: number
|
||||||
title: credit_line_total
|
title: credit_line_total
|
||||||
description: The order's credit line total.
|
description: The total amount of credit lines applied to the order, including taxes. Subtracted from the final total.
|
||||||
item_discount_total:
|
item_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_discount_total
|
title: item_discount_total
|
||||||
description: The total discount amount applied on the order's items.
|
description: The sum of all discounts applied to line items, including the tax portion of discounts.
|
||||||
shipping_discount_total:
|
shipping_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_discount_total
|
title: shipping_discount_total
|
||||||
description: The total discount amount applied on the order's shipping.
|
description: The sum of all discounts applied to shipping methods, including the tax portion of discounts.
|
||||||
custom_display_id:
|
custom_display_id:
|
||||||
type: string
|
type: string
|
||||||
title: custom_display_id
|
title: custom_display_id
|
||||||
@@ -85253,47 +85253,47 @@ components:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The item's total including taxes, excluding promotions.
|
description: The line item's original total before discounts, including taxes.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The item's total excluding taxes, including promotions.
|
description: The line item's original subtotal before discounts, excluding taxes.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The total taxes of the item, excluding promotions.
|
description: The line item's original tax total before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The total taxes of the item, including promotions.
|
description: The line item's total after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The item's total excluding taxes, including promotions.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The total taxes of the item, including promotions.
|
description: The line item's tax total after discounts.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The item's total, including taxes and promotions.
|
description: The line item's total after discounts, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The item's subtotal excluding taxes, including promotions.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The tax total of the item including promotions.
|
description: The line item's tax total after discounts.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The total discount amount of the item.
|
description: The total amount of discounts applied to the line item, including the tax portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The total taxes applied on the discounted amount.
|
description: The total amount of discounts applied to the line item's tax. Represents the tax portion of discounts.
|
||||||
refundable_total:
|
refundable_total:
|
||||||
type: number
|
type: number
|
||||||
title: refundable_total
|
title: refundable_total
|
||||||
@@ -89691,59 +89691,59 @@ components:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
title: original_item_total
|
||||||
description: The cart items' total including taxes, excluding promotions.
|
description: The sum of all line items' original totals before discounts, including taxes.
|
||||||
original_item_subtotal:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
title: original_item_subtotal
|
||||||
description: The cart items' total excluding taxes, including promotions.
|
description: The sum of all line items' original subtotals before discounts, excluding taxes.
|
||||||
original_item_tax_total:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
title: original_item_tax_total
|
||||||
description: The cart items' tax total excluding promotions.
|
description: The sum of all line items' original tax totals before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The cart items' total including taxes and promotions.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The cart items' total excluding taxes, including promotions.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The cart items' tax total including promotions.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The cart's total including taxes, excluding promotions.
|
description: The cart's total before discounts, including taxes. Calculated as the sum of `original_item_total` and `original_shipping_total`.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The cart's total excluding taxes, including promotions.
|
description: The cart's subtotal before discounts, excluding taxes. Calculated as the sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The cart's tax total excluding promotions.
|
description: The cart's tax total before discounts. Calculated as the sum of `original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The cart's total including taxes and promotions.
|
description: The cart's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The cart's total excluding taxes, including promotions.
|
description: The cart's subtotal before discounts, excluding taxes. Calculated as the sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The cart's tax total including promotions.
|
description: The cart's tax total after discounts. Calculated as the sum of `item_tax_total` and `shipping_tax_total`.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
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:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The tax total applied on the discounted amount.
|
description: The total amount of discounts applied to the cart's tax. Represents the tax portion of discounts.
|
||||||
gift_card_total:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -89755,27 +89755,27 @@ components:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The cart's shipping total including taxes and promotions.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The cart's shipping total excluding taxes, including promotions.
|
description: The sum of all shipping methods' subtotals before discounts, excluding taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
title: shipping_tax_total
|
||||||
description: The total taxes applied on the cart's shipping amount.
|
description: The sum of all shipping methods' tax totals after discounts.
|
||||||
original_shipping_total:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
title: original_shipping_total
|
||||||
description: The cart's shipping total including taxes, excluding promotions.
|
description: The sum of all shipping methods' original totals before discounts, including taxes.
|
||||||
original_shipping_subtotal:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
title: original_shipping_subtotal
|
||||||
description: The cart's shipping total excluding taxes, including promotions.
|
description: The sum of all shipping methods' original subtotals before discounts, excluding taxes.
|
||||||
original_shipping_tax_total:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
title: original_shipping_tax_total
|
||||||
description: The total taxes applied on the cart's shipping amount.
|
description: The sum of all shipping methods' original tax totals before discounts.
|
||||||
promotions:
|
promotions:
|
||||||
type: array
|
type: array
|
||||||
description: The cart's promotions.
|
description: The cart's promotions.
|
||||||
@@ -90163,47 +90163,47 @@ components:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The item's total including taxes, excluding promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's original total before discounts, including taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The item's total excluding taxes, including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's original subtotal before discounts, excluding taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The total taxes of the item excluding promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's original tax total before discounts. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: item_total
|
||||||
description: The item's total including taxes and promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's total after discounts, including taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The item's total excluding taxes, including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's subtotal before discounts, excluding taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The total taxes of the item including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's tax total after discounts. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The item's total including taxes and promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's total after discounts, including taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The item's total excluding taxes, including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's subtotal before discounts, excluding taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The total taxes of the item including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's tax total after discounts. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The total discount of the item. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The total amount of discounts applied to the line item, including the tax portion of discounts. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The total taxes applied on the discounted amount. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The total amount of discounts applied to the line item's tax. Represents the tax portion of discounts. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
StoreCartPromotion:
|
StoreCartPromotion:
|
||||||
type: object
|
type: object
|
||||||
description: The promotion's promotions.
|
description: The promotion's promotions.
|
||||||
@@ -90481,35 +90481,35 @@ components:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The shipping method's total including taxes, excluding promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The shipping method's original total before discounts, including taxes. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The shipping method's total excluding taxes, including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The shipping method's original subtotal before discounts, excluding taxes. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The total taxes applied on the shipping method's amount including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The shipping method's original tax total before discounts. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The shipping method's total amount including taxes and promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The shipping method's total after discounts, including taxes. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The shipping method's total amount excluding taxes, including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The shipping method's subtotal before discounts, excluding taxes. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The total taxes applied on the shipping method's amount including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The shipping method's tax total after discounts. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The total amount discounted. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The total amount of discounts applied to the shipping method, including the tax portion of discounts. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The taxes applied on the discounted amount. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The total amount of discounts applied to the shipping method's tax. Represents the tax portion of discounts. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
StoreCartShippingOption:
|
StoreCartShippingOption:
|
||||||
type: object
|
type: object
|
||||||
description: The shipping option's details.
|
description: The shipping option's details.
|
||||||
@@ -91509,59 +91509,59 @@ components:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
title: original_item_total
|
||||||
description: The order items' total including taxes, excluding promotions.
|
description: The sum of all line items' original totals before discounts, including taxes.
|
||||||
original_item_subtotal:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
title: original_item_subtotal
|
||||||
description: The order items' total excluding taxes, including promotions.
|
description: The sum of all line items' original subtotals before discounts, excluding taxes.
|
||||||
original_item_tax_total:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
title: original_item_tax_total
|
||||||
description: The total taxes applied on the order items, excluding promotions.
|
description: The sum of all line items' original tax totals before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The order items' total including taxes and promotions.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The order items' total excluding taxes, including promotions.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The total taxes applied on the order's items, including promotions.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The order's total including taxes, excluding promotions.
|
description: The order's total before discounts, including taxes. Calculated as the sum of `original_item_total` and `original_shipping_total`.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: The order's subtotal before discounts, excluding taxes. Calculated as the sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The total taxes of the order excluding promotions.
|
description: The order's tax total before discounts. Calculated as the sum of `original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The order's total including taxes and promotions.
|
description: The order's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: The order's subtotal before discounts, excluding taxes. Calculated as the sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The tax totals of the order including promotions.
|
description: The order's tax total after discounts. Calculated as the sum of `item_tax_total` and `shipping_tax_total`.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The order's discount total.
|
description: The total amount of discounts applied to the order, including the tax portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The total taxes applied on the discounted amount.
|
description: The total amount of discounts applied to the order's tax. Represents the tax portion of discounts.
|
||||||
gift_card_total:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -91573,27 +91573,27 @@ components:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The order's shipping total including taxes and promotions.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: The sum of all shipping methods' subtotals before discounts, excluding taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
title: shipping_tax_total
|
||||||
description: The total taxes of the order's shipping including promotions.
|
description: The sum of all shipping methods' tax totals after discounts.
|
||||||
original_shipping_total:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
title: original_shipping_total
|
||||||
description: The order's shipping total including taxes, excluding promotions.
|
description: The sum of all shipping methods' original totals before discounts, including taxes.
|
||||||
original_shipping_subtotal:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
title: original_shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: The sum of all shipping methods' original subtotals before discounts, excluding taxes.
|
||||||
original_shipping_tax_total:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
title: original_shipping_tax_total
|
||||||
description: The total taxes of the order's shipping excluding promotions.
|
description: The sum of all shipping methods' original tax totals before discounts.
|
||||||
customer:
|
customer:
|
||||||
$ref: '#/components/schemas/StoreCustomer'
|
$ref: '#/components/schemas/StoreCustomer'
|
||||||
transactions:
|
transactions:
|
||||||
@@ -91608,15 +91608,15 @@ components:
|
|||||||
credit_line_total:
|
credit_line_total:
|
||||||
type: number
|
type: number
|
||||||
title: credit_line_total
|
title: credit_line_total
|
||||||
description: The order's credit line total.
|
description: The total amount of credit lines applied to the order, including taxes. Subtracted from the final total.
|
||||||
item_discount_total:
|
item_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_discount_total
|
title: item_discount_total
|
||||||
description: The total discount amount applied on the order's items.
|
description: The sum of all discounts applied to line items, including the tax portion of discounts.
|
||||||
shipping_discount_total:
|
shipping_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_discount_total
|
title: shipping_discount_total
|
||||||
description: The total discount amount applied on the order's shipping.
|
description: The sum of all discounts applied to shipping methods, including the tax portion of discounts.
|
||||||
custom_display_id:
|
custom_display_id:
|
||||||
type: string
|
type: string
|
||||||
title: custom_display_id
|
title: custom_display_id
|
||||||
|
|||||||
@@ -89,59 +89,77 @@ properties:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
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:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
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:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
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:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The cart's item total.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The cart's item subtotal.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The cart's item tax total.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
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:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
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:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
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:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The cart's total.
|
description: The cart's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
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:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
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:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
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:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
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:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -153,24 +171,30 @@ properties:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The cart's shipping total.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The cart's shipping subtotal.
|
description: >-
|
||||||
|
The sum of all shipping methods' subtotals before discounts, excluding
|
||||||
|
taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
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:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
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:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
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:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
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.
|
||||||
@@ -143,44 +143,48 @@ properties:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The item's original total.
|
description: The line item's original total before discounts, including taxes.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The item's original subtotal.
|
description: The line item's original subtotal before discounts, excluding taxes.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The item's original tax total.
|
description: The line item's original tax total before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The item's item total.
|
description: The line item's total after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The item's item subtotal.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The item's item tax total.
|
description: The line item's tax total after discounts.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The item's total.
|
description: The line item's total after discounts, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The item's subtotal.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The item's tax total.
|
description: The line item's tax total after discounts.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The item's discount total.
|
description: >-
|
||||||
|
The total amount of discounts applied to the line item, including the tax
|
||||||
|
portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The item's discount tax total.
|
description: >-
|
||||||
|
The total amount of discounts applied to the line item's tax. Represents
|
||||||
|
the tax portion of discounts.
|
||||||
@@ -75,36 +75,36 @@ properties:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The shipping method's total including taxes, excluding promotions.
|
description: The shipping method's original total before discounts, including taxes.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The shipping method's total excluding taxes, including promotions.
|
description: The shipping method's original subtotal before discounts, excluding taxes.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: >-
|
description: The shipping method's original tax total before discounts.
|
||||||
The total taxes applied on the shipping method's amount including
|
|
||||||
promotions.
|
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The shipping method's total amount including taxes and promotions.
|
description: The shipping method's total after discounts, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The shipping method's total amount excluding taxes, including promotions.
|
description: The shipping method's subtotal before discounts, excluding taxes.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: >-
|
description: The shipping method's tax total after discounts.
|
||||||
The total taxes applied on the shipping method's amount including
|
|
||||||
promotions.
|
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The total amount discounted.
|
description: >-
|
||||||
|
The total amount of discounts applied to the shipping method, including
|
||||||
|
the tax portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The taxes applied on the discounted amount.
|
description: >-
|
||||||
|
The total amount of discounts applied to the shipping method's tax.
|
||||||
|
Represents the tax portion of discounts.
|
||||||
@@ -152,59 +152,77 @@ properties:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
title: original_item_total
|
||||||
description: The total of the order's items including taxes, excluding promotions.
|
description: >-
|
||||||
|
The sum of all line items' original totals before discounts, including
|
||||||
|
taxes.
|
||||||
original_item_subtotal:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
title: original_item_subtotal
|
||||||
description: The total of the order's items excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all line items' original subtotals before discounts, excluding
|
||||||
|
taxes.
|
||||||
original_item_tax_total:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
title: original_item_tax_total
|
||||||
description: The tax total of the order's items excluding promotions.
|
description: The sum of all line items' original tax totals before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The total of the order's items including taxes and promotions.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The total of the order's items excluding taxes, including promotions.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The tax total of the order's items including promotions.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The order's total excluding promotions, including taxes.
|
description: >-
|
||||||
|
The order's total before discounts, including taxes. Calculated as the sum
|
||||||
|
of `original_item_total` and `original_shipping_total`.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The order's subtotal before discounts, excluding taxes. Calculated as the
|
||||||
|
sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The order's tax total, excluding promotions.
|
description: >-
|
||||||
|
The order's tax total before discounts. Calculated as the sum of
|
||||||
|
`original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The order's total including taxes and promotions.
|
description: The order's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The order's subtotal before discounts, excluding taxes. Calculated as the
|
||||||
|
sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The order's tax total including promotions.
|
description: >-
|
||||||
|
The order's tax total after discounts. Calculated as the sum of
|
||||||
|
`item_tax_total` and `shipping_tax_total`.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The order's discount or promotions total.
|
description: >-
|
||||||
|
The total amount of discounts applied to the order, including the tax
|
||||||
|
portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The tax total of order's discount or promotion.
|
description: >-
|
||||||
|
The total amount of discounts applied to the order's tax. Represents the
|
||||||
|
tax portion of discounts.
|
||||||
gift_card_total:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -216,27 +234,33 @@ properties:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The order's shipping total including taxes and promotions.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' subtotals before discounts, excluding
|
||||||
|
taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
title: shipping_tax_total
|
||||||
description: The tax total of the order's shipping.
|
description: The sum of all shipping methods' tax totals after discounts.
|
||||||
original_shipping_total:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
title: original_shipping_total
|
||||||
description: The order's shipping total including taxes, excluding promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' original totals before discounts,
|
||||||
|
including taxes.
|
||||||
original_shipping_subtotal:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
title: original_shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' original subtotals before discounts,
|
||||||
|
excluding taxes.
|
||||||
original_shipping_tax_total:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
title: original_shipping_tax_total
|
||||||
description: The tax total of the order's shipping excluding promotions.
|
description: The sum of all shipping methods' original tax totals before discounts.
|
||||||
status:
|
status:
|
||||||
type: string
|
type: string
|
||||||
title: status
|
title: status
|
||||||
@@ -244,15 +268,21 @@ properties:
|
|||||||
credit_line_total:
|
credit_line_total:
|
||||||
type: number
|
type: number
|
||||||
title: credit_line_total
|
title: credit_line_total
|
||||||
description: The order's credit line total.
|
description: >-
|
||||||
|
The total amount of credit lines applied to the order, including taxes.
|
||||||
|
Subtracted from the final total.
|
||||||
item_discount_total:
|
item_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_discount_total
|
title: item_discount_total
|
||||||
description: The total discount amount applied on the order's items.
|
description: >-
|
||||||
|
The sum of all discounts applied to line items, including the tax portion
|
||||||
|
of discounts.
|
||||||
shipping_discount_total:
|
shipping_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_discount_total
|
title: shipping_discount_total
|
||||||
description: The total discount amount applied on the order's shipping.
|
description: >-
|
||||||
|
The sum of all discounts applied to shipping methods, including the tax
|
||||||
|
portion of discounts.
|
||||||
custom_display_id:
|
custom_display_id:
|
||||||
type: string
|
type: string
|
||||||
title: custom_display_id
|
title: custom_display_id
|
||||||
|
|||||||
@@ -166,47 +166,51 @@ properties:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The item's total including taxes, excluding promotions.
|
description: The line item's original total before discounts, including taxes.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The item's total excluding taxes, including promotions.
|
description: The line item's original subtotal before discounts, excluding taxes.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The total taxes of the item, excluding promotions.
|
description: The line item's original tax total before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The total taxes of the item, including promotions.
|
description: The line item's total after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The item's total excluding taxes, including promotions.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The total taxes of the item, including promotions.
|
description: The line item's tax total after discounts.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The item's total, including taxes and promotions.
|
description: The line item's total after discounts, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The item's subtotal excluding taxes, including promotions.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The tax total of the item including promotions.
|
description: The line item's tax total after discounts.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The total discount amount of the item.
|
description: >-
|
||||||
|
The total amount of discounts applied to the line item, including the tax
|
||||||
|
portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The total taxes applied on the discounted amount.
|
description: >-
|
||||||
|
The total amount of discounts applied to the line item's tax. Represents
|
||||||
|
the tax portion of discounts.
|
||||||
refundable_total:
|
refundable_total:
|
||||||
type: number
|
type: number
|
||||||
title: refundable_total
|
title: refundable_total
|
||||||
|
|||||||
@@ -94,59 +94,77 @@ properties:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
title: original_item_total
|
||||||
description: The cart items' total including taxes, excluding promotions.
|
description: >-
|
||||||
|
The sum of all line items' original totals before discounts, including
|
||||||
|
taxes.
|
||||||
original_item_subtotal:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
title: original_item_subtotal
|
||||||
description: The cart items' total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all line items' original subtotals before discounts, excluding
|
||||||
|
taxes.
|
||||||
original_item_tax_total:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
title: original_item_tax_total
|
||||||
description: The cart items' tax total excluding promotions.
|
description: The sum of all line items' original tax totals before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The cart items' total including taxes and promotions.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The cart items' total excluding taxes, including promotions.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The cart items' tax total including promotions.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The cart's total including taxes, excluding promotions.
|
description: >-
|
||||||
|
The cart's total before discounts, including taxes. Calculated as the sum
|
||||||
|
of `original_item_total` and `original_shipping_total`.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The cart's total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The cart's subtotal before discounts, excluding taxes. Calculated as the
|
||||||
|
sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The cart's tax total excluding promotions.
|
description: >-
|
||||||
|
The cart's tax total before discounts. Calculated as the sum of
|
||||||
|
`original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The cart's total including taxes and promotions.
|
description: The cart's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The cart's total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The cart's subtotal before discounts, excluding taxes. Calculated as the
|
||||||
|
sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The cart's tax total including promotions.
|
description: >-
|
||||||
|
The cart's tax total after discounts. Calculated as the sum of
|
||||||
|
`item_tax_total` and `shipping_tax_total`.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
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:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The tax total applied on the discounted amount.
|
description: >-
|
||||||
|
The total amount of discounts applied to the cart's tax. Represents the
|
||||||
|
tax portion of discounts.
|
||||||
gift_card_total:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -158,27 +176,33 @@ properties:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The cart's shipping total including taxes and promotions.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The cart's shipping total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' subtotals before discounts, excluding
|
||||||
|
taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
title: shipping_tax_total
|
||||||
description: The total taxes applied on the cart's shipping amount.
|
description: The sum of all shipping methods' tax totals after discounts.
|
||||||
original_shipping_total:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
title: original_shipping_total
|
||||||
description: The cart's shipping total including taxes, excluding promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' original totals before discounts,
|
||||||
|
including taxes.
|
||||||
original_shipping_subtotal:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
title: original_shipping_subtotal
|
||||||
description: The cart's shipping total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' original subtotals before discounts,
|
||||||
|
excluding taxes.
|
||||||
original_shipping_tax_total:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
title: original_shipping_tax_total
|
||||||
description: The total taxes applied on the cart's shipping amount.
|
description: The sum of all shipping methods' original tax totals before discounts.
|
||||||
promotions:
|
promotions:
|
||||||
type: array
|
type: array
|
||||||
description: The cart's promotions.
|
description: The cart's promotions.
|
||||||
|
|||||||
@@ -288,31 +288,33 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: >-
|
description: >-
|
||||||
The item's total including taxes, excluding promotions. This field is only
|
The line item's original total before discounts, including taxes. This
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
field is only available if you expand the `items.*` relation. Learn more
|
||||||
|
in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: >-
|
description: >-
|
||||||
The item's total excluding taxes, including promotions. This field is only
|
The line item's original subtotal before discounts, excluding taxes. This
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
field is only available if you expand the `items.*` relation. Learn more
|
||||||
|
in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: >-
|
description: >-
|
||||||
The total taxes of the item excluding promotions. This field is only
|
The line item's original tax total before discounts. This field is only
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: item_total
|
||||||
description: >-
|
description: >-
|
||||||
The item's total including taxes and promotions. This field is only
|
The line item's total after discounts, including taxes. This field is only
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
@@ -320,23 +322,24 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: >-
|
description: >-
|
||||||
The item's total excluding taxes, including promotions. This field is only
|
The line item's subtotal before discounts, excluding taxes. This field is
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
only available if you expand the `items.*` relation. Learn more in the
|
||||||
|
[Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: >-
|
description: >-
|
||||||
The total taxes of the item including promotions. This field is only
|
The line item's tax total after discounts. This field is only available if
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
you expand the `items.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: >-
|
description: >-
|
||||||
The item's total including taxes and promotions. This field is only
|
The line item's total after discounts, including taxes. This field is only
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
@@ -344,31 +347,34 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: >-
|
description: >-
|
||||||
The item's total excluding taxes, including promotions. This field is only
|
The line item's subtotal before discounts, excluding taxes. This field is
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
only available if you expand the `items.*` relation. Learn more in the
|
||||||
|
[Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: >-
|
description: >-
|
||||||
The total taxes of the item including promotions. This field is only
|
The line item's tax total after discounts. This field is only available if
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
you expand the `items.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: >-
|
description: >-
|
||||||
The total discount of the item. This field is only available if you expand
|
The total amount of discounts applied to the line item, including the tax
|
||||||
the `items.*` relation. Learn more in the [Cart
|
portion of discounts. This field is only available if you expand the
|
||||||
|
`items.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: >-
|
description: >-
|
||||||
The total taxes applied on the discounted amount. This field is only
|
The total amount of discounts applied to the line item's tax. Represents
|
||||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
the tax portion of discounts. This field is only available if you expand
|
||||||
|
the `items.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||||
guide.
|
guide.
|
||||||
+23
-21
@@ -214,61 +214,62 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: >-
|
description: >-
|
||||||
The shipping method's total including taxes, excluding promotions. This
|
The shipping method's original total before discounts, including taxes.
|
||||||
field is only available if you expand the `shipping_methods.*` relation.
|
This field is only available if you expand the `shipping_methods.*`
|
||||||
Learn more in the [Cart
|
relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: >-
|
description: >-
|
||||||
The shipping method's total excluding taxes, including promotions. This
|
The shipping method's original subtotal before discounts, excluding taxes.
|
||||||
field is only available if you expand the `shipping_methods.*` relation.
|
This field is only available if you expand the `shipping_methods.*`
|
||||||
Learn more in the [Cart
|
relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: >-
|
description: >-
|
||||||
The total taxes applied on the shipping method's amount including
|
The shipping method's original tax total before discounts. This field is
|
||||||
promotions. This field is only available if you expand the
|
only available if you expand the `shipping_methods.*` relation. Learn more
|
||||||
`shipping_methods.*` relation. Learn more in the [Cart
|
in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: >-
|
description: >-
|
||||||
The shipping method's total amount including taxes and promotions. This
|
The shipping method's total after discounts, including taxes. This field
|
||||||
field is only available if you expand the `shipping_methods.*` relation.
|
is only available if you expand the `shipping_methods.*` relation. Learn
|
||||||
Learn more in the [Cart
|
more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: >-
|
description: >-
|
||||||
The shipping method's total amount excluding taxes, including promotions.
|
The shipping method's subtotal before discounts, excluding taxes. This
|
||||||
This field is only available if you expand the `shipping_methods.*`
|
field is only available if you expand the `shipping_methods.*` relation.
|
||||||
relation. Learn more in the [Cart
|
Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: >-
|
description: >-
|
||||||
The total taxes applied on the shipping method's amount including
|
The shipping method's tax total after discounts. This field is only
|
||||||
promotions. This field is only available if you expand the
|
available if you expand the `shipping_methods.*` relation. Learn more in
|
||||||
`shipping_methods.*` relation. Learn more in the [Cart
|
the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: >-
|
description: >-
|
||||||
The total amount discounted. This field is only available if you expand
|
The total amount of discounts applied to the shipping method, including
|
||||||
|
the tax portion of discounts. This field is only available if you expand
|
||||||
the `shipping_methods.*` relation. Learn more in the [Cart
|
the `shipping_methods.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
@@ -276,7 +277,8 @@ properties:
|
|||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: >-
|
description: >-
|
||||||
The taxes applied on the discounted amount. This field is only available
|
The total amount of discounts applied to the shipping method's tax.
|
||||||
if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
Represents the tax portion of discounts. This field is only available if
|
||||||
|
you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
||||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||||
guide.
|
guide.
|
||||||
@@ -143,59 +143,77 @@ properties:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
title: original_item_total
|
||||||
description: The order items' total including taxes, excluding promotions.
|
description: >-
|
||||||
|
The sum of all line items' original totals before discounts, including
|
||||||
|
taxes.
|
||||||
original_item_subtotal:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
title: original_item_subtotal
|
||||||
description: The order items' total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all line items' original subtotals before discounts, excluding
|
||||||
|
taxes.
|
||||||
original_item_tax_total:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
title: original_item_tax_total
|
||||||
description: The total taxes applied on the order items, excluding promotions.
|
description: The sum of all line items' original tax totals before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The order items' total including taxes and promotions.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The order items' total excluding taxes, including promotions.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The total taxes applied on the order's items, including promotions.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The order's total including taxes, excluding promotions.
|
description: >-
|
||||||
|
The order's total before discounts, including taxes. Calculated as the sum
|
||||||
|
of `original_item_total` and `original_shipping_total`.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The order's subtotal before discounts, excluding taxes. Calculated as the
|
||||||
|
sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The total taxes of the order excluding promotions.
|
description: >-
|
||||||
|
The order's tax total before discounts. Calculated as the sum of
|
||||||
|
`original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The order's total including taxes and promotions.
|
description: The order's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The order's subtotal before discounts, excluding taxes. Calculated as the
|
||||||
|
sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The tax totals of the order including promotions.
|
description: >-
|
||||||
|
The order's tax total after discounts. Calculated as the sum of
|
||||||
|
`item_tax_total` and `shipping_tax_total`.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The order's discount total.
|
description: >-
|
||||||
|
The total amount of discounts applied to the order, including the tax
|
||||||
|
portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The total taxes applied on the discounted amount.
|
description: >-
|
||||||
|
The total amount of discounts applied to the order's tax. Represents the
|
||||||
|
tax portion of discounts.
|
||||||
gift_card_total:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -207,27 +225,33 @@ properties:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The order's shipping total including taxes and promotions.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' subtotals before discounts, excluding
|
||||||
|
taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
title: shipping_tax_total
|
||||||
description: The total taxes of the order's shipping including promotions.
|
description: The sum of all shipping methods' tax totals after discounts.
|
||||||
original_shipping_total:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
title: original_shipping_total
|
||||||
description: The order's shipping total including taxes, excluding promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' original totals before discounts,
|
||||||
|
including taxes.
|
||||||
original_shipping_subtotal:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
title: original_shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: >-
|
||||||
|
The sum of all shipping methods' original subtotals before discounts,
|
||||||
|
excluding taxes.
|
||||||
original_shipping_tax_total:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
title: original_shipping_tax_total
|
||||||
description: The total taxes of the order's shipping excluding promotions.
|
description: The sum of all shipping methods' original tax totals before discounts.
|
||||||
customer:
|
customer:
|
||||||
$ref: ./StoreCustomer.yaml
|
$ref: ./StoreCustomer.yaml
|
||||||
transactions:
|
transactions:
|
||||||
@@ -242,15 +266,21 @@ properties:
|
|||||||
credit_line_total:
|
credit_line_total:
|
||||||
type: number
|
type: number
|
||||||
title: credit_line_total
|
title: credit_line_total
|
||||||
description: The order's credit line total.
|
description: >-
|
||||||
|
The total amount of credit lines applied to the order, including taxes.
|
||||||
|
Subtracted from the final total.
|
||||||
item_discount_total:
|
item_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_discount_total
|
title: item_discount_total
|
||||||
description: The total discount amount applied on the order's items.
|
description: >-
|
||||||
|
The sum of all discounts applied to line items, including the tax portion
|
||||||
|
of discounts.
|
||||||
shipping_discount_total:
|
shipping_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_discount_total
|
title: shipping_discount_total
|
||||||
description: The total discount amount applied on the order's shipping.
|
description: >-
|
||||||
|
The sum of all discounts applied to shipping methods, including the tax
|
||||||
|
portion of discounts.
|
||||||
custom_display_id:
|
custom_display_id:
|
||||||
type: string
|
type: string
|
||||||
title: custom_display_id
|
title: custom_display_id
|
||||||
|
|||||||
@@ -26978,59 +26978,59 @@ components:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
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:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
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:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
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:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The cart's item total.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The cart's item subtotal.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The cart's item tax total.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
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:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
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:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
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:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The cart's total.
|
description: The cart's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
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:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
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:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
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:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
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:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -27042,27 +27042,27 @@ components:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The cart's shipping total.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The cart's shipping subtotal.
|
description: The sum of all shipping methods' subtotals before discounts, excluding taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
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:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
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:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
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:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
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.
|
||||||
BaseCartAddress:
|
BaseCartAddress:
|
||||||
type: object
|
type: object
|
||||||
description: The cart's shipping address.
|
description: The cart's shipping address.
|
||||||
@@ -27213,47 +27213,47 @@ components:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The item's original total.
|
description: The line item's original total before discounts, including taxes.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The item's original subtotal.
|
description: The line item's original subtotal before discounts, excluding taxes.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The item's original tax total.
|
description: The line item's original tax total before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The item's item total.
|
description: The line item's total after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The item's item subtotal.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The item's item tax total.
|
description: The line item's tax total after discounts.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The item's total.
|
description: The line item's total after discounts, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The item's subtotal.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The item's tax total.
|
description: The line item's tax total after discounts.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The item's discount total.
|
description: The total amount of discounts applied to the line item, including the tax portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The item's discount tax total.
|
description: The total amount of discounts applied to the line item's tax. Represents the tax portion of discounts.
|
||||||
BaseCartShippingMethod:
|
BaseCartShippingMethod:
|
||||||
type: object
|
type: object
|
||||||
description: A cart's shipping method.
|
description: A cart's shipping method.
|
||||||
@@ -27329,35 +27329,35 @@ components:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The shipping method's total including taxes, excluding promotions.
|
description: The shipping method's original total before discounts, including taxes.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The shipping method's total excluding taxes, including promotions.
|
description: The shipping method's original subtotal before discounts, excluding taxes.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The total taxes applied on the shipping method's amount including promotions.
|
description: The shipping method's original tax total before discounts.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The shipping method's total amount including taxes and promotions.
|
description: The shipping method's total after discounts, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The shipping method's total amount excluding taxes, including promotions.
|
description: The shipping method's subtotal before discounts, excluding taxes.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The total taxes applied on the shipping method's amount including promotions.
|
description: The shipping method's tax total after discounts.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The total amount discounted.
|
description: The total amount of discounts applied to the shipping method, including the tax portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The taxes applied on the discounted amount.
|
description: The total amount of discounts applied to the shipping method's tax. Represents the tax portion of discounts.
|
||||||
BaseClaimItem:
|
BaseClaimItem:
|
||||||
type: object
|
type: object
|
||||||
description: The claim item's details.
|
description: The claim item's details.
|
||||||
@@ -27820,59 +27820,59 @@ components:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
title: original_item_total
|
||||||
description: The total of the order's items including taxes, excluding promotions.
|
description: The sum of all line items' original totals before discounts, including taxes.
|
||||||
original_item_subtotal:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
title: original_item_subtotal
|
||||||
description: The total of the order's items excluding taxes, including promotions.
|
description: The sum of all line items' original subtotals before discounts, excluding taxes.
|
||||||
original_item_tax_total:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
title: original_item_tax_total
|
||||||
description: The tax total of the order's items excluding promotions.
|
description: The sum of all line items' original tax totals before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The total of the order's items including taxes and promotions.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The total of the order's items excluding taxes, including promotions.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The tax total of the order's items including promotions.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The order's total excluding promotions, including taxes.
|
description: The order's total before discounts, including taxes. Calculated as the sum of `original_item_total` and `original_shipping_total`.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: The order's subtotal before discounts, excluding taxes. Calculated as the sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The order's tax total, excluding promotions.
|
description: The order's tax total before discounts. Calculated as the sum of `original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The order's total including taxes and promotions.
|
description: The order's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: The order's subtotal before discounts, excluding taxes. Calculated as the sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The order's tax total including promotions.
|
description: The order's tax total after discounts. Calculated as the sum of `item_tax_total` and `shipping_tax_total`.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The order's discount or promotions total.
|
description: The total amount of discounts applied to the order, including the tax portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The tax total of order's discount or promotion.
|
description: The total amount of discounts applied to the order's tax. Represents the tax portion of discounts.
|
||||||
gift_card_total:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -27884,27 +27884,27 @@ components:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The order's shipping total including taxes and promotions.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: The sum of all shipping methods' subtotals before discounts, excluding taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
title: shipping_tax_total
|
||||||
description: The tax total of the order's shipping.
|
description: The sum of all shipping methods' tax totals after discounts.
|
||||||
original_shipping_total:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
title: original_shipping_total
|
||||||
description: The order's shipping total including taxes, excluding promotions.
|
description: The sum of all shipping methods' original totals before discounts, including taxes.
|
||||||
original_shipping_subtotal:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
title: original_shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: The sum of all shipping methods' original subtotals before discounts, excluding taxes.
|
||||||
original_shipping_tax_total:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
title: original_shipping_tax_total
|
||||||
description: The tax total of the order's shipping excluding promotions.
|
description: The sum of all shipping methods' original tax totals before discounts.
|
||||||
status:
|
status:
|
||||||
type: string
|
type: string
|
||||||
title: status
|
title: status
|
||||||
@@ -27912,15 +27912,15 @@ components:
|
|||||||
credit_line_total:
|
credit_line_total:
|
||||||
type: number
|
type: number
|
||||||
title: credit_line_total
|
title: credit_line_total
|
||||||
description: The order's credit line total.
|
description: The total amount of credit lines applied to the order, including taxes. Subtracted from the final total.
|
||||||
item_discount_total:
|
item_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_discount_total
|
title: item_discount_total
|
||||||
description: The total discount amount applied on the order's items.
|
description: The sum of all discounts applied to line items, including the tax portion of discounts.
|
||||||
shipping_discount_total:
|
shipping_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_discount_total
|
title: shipping_discount_total
|
||||||
description: The total discount amount applied on the order's shipping.
|
description: The sum of all discounts applied to shipping methods, including the tax portion of discounts.
|
||||||
custom_display_id:
|
custom_display_id:
|
||||||
type: string
|
type: string
|
||||||
title: custom_display_id
|
title: custom_display_id
|
||||||
@@ -28331,47 +28331,47 @@ components:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The item's total including taxes, excluding promotions.
|
description: The line item's original total before discounts, including taxes.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The item's total excluding taxes, including promotions.
|
description: The line item's original subtotal before discounts, excluding taxes.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The total taxes of the item, excluding promotions.
|
description: The line item's original tax total before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The total taxes of the item, including promotions.
|
description: The line item's total after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The item's total excluding taxes, including promotions.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The total taxes of the item, including promotions.
|
description: The line item's tax total after discounts.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The item's total, including taxes and promotions.
|
description: The line item's total after discounts, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The item's subtotal excluding taxes, including promotions.
|
description: The line item's subtotal before discounts, excluding taxes.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The tax total of the item including promotions.
|
description: The line item's tax total after discounts.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The total discount amount of the item.
|
description: The total amount of discounts applied to the line item, including the tax portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The total taxes applied on the discounted amount.
|
description: The total amount of discounts applied to the line item's tax. Represents the tax portion of discounts.
|
||||||
refundable_total:
|
refundable_total:
|
||||||
type: number
|
type: number
|
||||||
title: refundable_total
|
title: refundable_total
|
||||||
@@ -32769,59 +32769,59 @@ components:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
title: original_item_total
|
||||||
description: The cart items' total including taxes, excluding promotions.
|
description: The sum of all line items' original totals before discounts, including taxes.
|
||||||
original_item_subtotal:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
title: original_item_subtotal
|
||||||
description: The cart items' total excluding taxes, including promotions.
|
description: The sum of all line items' original subtotals before discounts, excluding taxes.
|
||||||
original_item_tax_total:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
title: original_item_tax_total
|
||||||
description: The cart items' tax total excluding promotions.
|
description: The sum of all line items' original tax totals before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The cart items' total including taxes and promotions.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The cart items' total excluding taxes, including promotions.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The cart items' tax total including promotions.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The cart's total including taxes, excluding promotions.
|
description: The cart's total before discounts, including taxes. Calculated as the sum of `original_item_total` and `original_shipping_total`.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The cart's total excluding taxes, including promotions.
|
description: The cart's subtotal before discounts, excluding taxes. Calculated as the sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The cart's tax total excluding promotions.
|
description: The cart's tax total before discounts. Calculated as the sum of `original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The cart's total including taxes and promotions.
|
description: The cart's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The cart's total excluding taxes, including promotions.
|
description: The cart's subtotal before discounts, excluding taxes. Calculated as the sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The cart's tax total including promotions.
|
description: The cart's tax total after discounts. Calculated as the sum of `item_tax_total` and `shipping_tax_total`.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
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:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The tax total applied on the discounted amount.
|
description: The total amount of discounts applied to the cart's tax. Represents the tax portion of discounts.
|
||||||
gift_card_total:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -32833,27 +32833,27 @@ components:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The cart's shipping total including taxes and promotions.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The cart's shipping total excluding taxes, including promotions.
|
description: The sum of all shipping methods' subtotals before discounts, excluding taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
title: shipping_tax_total
|
||||||
description: The total taxes applied on the cart's shipping amount.
|
description: The sum of all shipping methods' tax totals after discounts.
|
||||||
original_shipping_total:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
title: original_shipping_total
|
||||||
description: The cart's shipping total including taxes, excluding promotions.
|
description: The sum of all shipping methods' original totals before discounts, including taxes.
|
||||||
original_shipping_subtotal:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
title: original_shipping_subtotal
|
||||||
description: The cart's shipping total excluding taxes, including promotions.
|
description: The sum of all shipping methods' original subtotals before discounts, excluding taxes.
|
||||||
original_shipping_tax_total:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
title: original_shipping_tax_total
|
||||||
description: The total taxes applied on the cart's shipping amount.
|
description: The sum of all shipping methods' original tax totals before discounts.
|
||||||
promotions:
|
promotions:
|
||||||
type: array
|
type: array
|
||||||
description: The cart's promotions.
|
description: The cart's promotions.
|
||||||
@@ -33241,47 +33241,47 @@ components:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The item's total including taxes, excluding promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's original total before discounts, including taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The item's total excluding taxes, including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's original subtotal before discounts, excluding taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The total taxes of the item excluding promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's original tax total before discounts. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: item_total
|
||||||
description: The item's total including taxes and promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's total after discounts, including taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The item's total excluding taxes, including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's subtotal before discounts, excluding taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The total taxes of the item including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's tax total after discounts. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The item's total including taxes and promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's total after discounts, including taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The item's total excluding taxes, including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's subtotal before discounts, excluding taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The total taxes of the item including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The line item's tax total after discounts. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The total discount of the item. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The total amount of discounts applied to the line item, including the tax portion of discounts. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The total taxes applied on the discounted amount. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
description: The total amount of discounts applied to the line item's tax. Represents the tax portion of discounts. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
StoreCartPromotion:
|
StoreCartPromotion:
|
||||||
type: object
|
type: object
|
||||||
description: The promotion's promotions.
|
description: The promotion's promotions.
|
||||||
@@ -33559,35 +33559,35 @@ components:
|
|||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The shipping method's total including taxes, excluding promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The shipping method's original total before discounts, including taxes. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The shipping method's total excluding taxes, including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The shipping method's original subtotal before discounts, excluding taxes. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The total taxes applied on the shipping method's amount including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The shipping method's original tax total before discounts. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The shipping method's total amount including taxes and promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The shipping method's total after discounts, including taxes. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The shipping method's total amount excluding taxes, including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The shipping method's subtotal before discounts, excluding taxes. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The total taxes applied on the shipping method's amount including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The shipping method's tax total after discounts. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The total amount discounted. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The total amount of discounts applied to the shipping method, including the tax portion of discounts. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The taxes applied on the discounted amount. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
description: The total amount of discounts applied to the shipping method's tax. Represents the tax portion of discounts. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
StoreCartShippingOption:
|
StoreCartShippingOption:
|
||||||
type: object
|
type: object
|
||||||
description: The shipping option's details.
|
description: The shipping option's details.
|
||||||
@@ -34587,59 +34587,59 @@ components:
|
|||||||
original_item_total:
|
original_item_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_total
|
title: original_item_total
|
||||||
description: The order items' total including taxes, excluding promotions.
|
description: The sum of all line items' original totals before discounts, including taxes.
|
||||||
original_item_subtotal:
|
original_item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_subtotal
|
title: original_item_subtotal
|
||||||
description: The order items' total excluding taxes, including promotions.
|
description: The sum of all line items' original subtotals before discounts, excluding taxes.
|
||||||
original_item_tax_total:
|
original_item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_item_tax_total
|
title: original_item_tax_total
|
||||||
description: The total taxes applied on the order items, excluding promotions.
|
description: The sum of all line items' original tax totals before discounts.
|
||||||
item_total:
|
item_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_total
|
title: item_total
|
||||||
description: The order items' total including taxes and promotions.
|
description: The sum of all line items' totals after discounts, including taxes.
|
||||||
item_subtotal:
|
item_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: item_subtotal
|
title: item_subtotal
|
||||||
description: The order items' total excluding taxes, including promotions.
|
description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
item_tax_total:
|
item_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_tax_total
|
title: item_tax_total
|
||||||
description: The total taxes applied on the order's items, including promotions.
|
description: The sum of all line items' tax totals after discounts.
|
||||||
original_total:
|
original_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_total
|
title: original_total
|
||||||
description: The order's total including taxes, excluding promotions.
|
description: The order's total before discounts, including taxes. Calculated as the sum of `original_item_total` and `original_shipping_total`.
|
||||||
original_subtotal:
|
original_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_subtotal
|
title: original_subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: The order's subtotal before discounts, excluding taxes. Calculated as the sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
original_tax_total:
|
original_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_tax_total
|
title: original_tax_total
|
||||||
description: The total taxes of the order excluding promotions.
|
description: The order's tax total before discounts. Calculated as the sum of `original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
total:
|
total:
|
||||||
type: number
|
type: number
|
||||||
title: total
|
title: total
|
||||||
description: The order's total including taxes and promotions.
|
description: The order's final total after discounts and credit lines, including taxes.
|
||||||
subtotal:
|
subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: subtotal
|
title: subtotal
|
||||||
description: The order's total excluding taxes, including promotions.
|
description: The order's subtotal before discounts, excluding taxes. Calculated as the sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
tax_total:
|
tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: tax_total
|
title: tax_total
|
||||||
description: The tax totals of the order including promotions.
|
description: The order's tax total after discounts. Calculated as the sum of `item_tax_total` and `shipping_tax_total`.
|
||||||
discount_total:
|
discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_total
|
title: discount_total
|
||||||
description: The order's discount total.
|
description: The total amount of discounts applied to the order, including the tax portion of discounts.
|
||||||
discount_tax_total:
|
discount_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: discount_tax_total
|
title: discount_tax_total
|
||||||
description: The total taxes applied on the discounted amount.
|
description: The total amount of discounts applied to the order's tax. Represents the tax portion of discounts.
|
||||||
gift_card_total:
|
gift_card_total:
|
||||||
type: number
|
type: number
|
||||||
title: gift_card_total
|
title: gift_card_total
|
||||||
@@ -34651,27 +34651,27 @@ components:
|
|||||||
shipping_total:
|
shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_total
|
title: shipping_total
|
||||||
description: The order's shipping total including taxes and promotions.
|
description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
shipping_subtotal:
|
shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_subtotal
|
title: shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: The sum of all shipping methods' subtotals before discounts, excluding taxes.
|
||||||
shipping_tax_total:
|
shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_tax_total
|
title: shipping_tax_total
|
||||||
description: The total taxes of the order's shipping including promotions.
|
description: The sum of all shipping methods' tax totals after discounts.
|
||||||
original_shipping_total:
|
original_shipping_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_total
|
title: original_shipping_total
|
||||||
description: The order's shipping total including taxes, excluding promotions.
|
description: The sum of all shipping methods' original totals before discounts, including taxes.
|
||||||
original_shipping_subtotal:
|
original_shipping_subtotal:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_subtotal
|
title: original_shipping_subtotal
|
||||||
description: The order's shipping total excluding taxes, including promotions.
|
description: The sum of all shipping methods' original subtotals before discounts, excluding taxes.
|
||||||
original_shipping_tax_total:
|
original_shipping_tax_total:
|
||||||
type: number
|
type: number
|
||||||
title: original_shipping_tax_total
|
title: original_shipping_tax_total
|
||||||
description: The total taxes of the order's shipping excluding promotions.
|
description: The sum of all shipping methods' original tax totals before discounts.
|
||||||
customer:
|
customer:
|
||||||
$ref: '#/components/schemas/StoreCustomer'
|
$ref: '#/components/schemas/StoreCustomer'
|
||||||
transactions:
|
transactions:
|
||||||
@@ -34686,15 +34686,15 @@ components:
|
|||||||
credit_line_total:
|
credit_line_total:
|
||||||
type: number
|
type: number
|
||||||
title: credit_line_total
|
title: credit_line_total
|
||||||
description: The order's credit line total.
|
description: The total amount of credit lines applied to the order, including taxes. Subtracted from the final total.
|
||||||
item_discount_total:
|
item_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: item_discount_total
|
title: item_discount_total
|
||||||
description: The total discount amount applied on the order's items.
|
description: The sum of all discounts applied to line items, including the tax portion of discounts.
|
||||||
shipping_discount_total:
|
shipping_discount_total:
|
||||||
type: number
|
type: number
|
||||||
title: shipping_discount_total
|
title: shipping_discount_total
|
||||||
description: The total discount amount applied on the order's shipping.
|
description: The sum of all discounts applied to shipping methods, including the tax portion of discounts.
|
||||||
custom_display_id:
|
custom_display_id:
|
||||||
type: string
|
type: string
|
||||||
title: custom_display_id
|
title: custom_display_id
|
||||||
|
|||||||
@@ -195,57 +195,57 @@ The returned `cart` object will look like this:
|
|||||||
|
|
||||||
The cart will include the following total fields:
|
The cart will include the following total fields:
|
||||||
|
|
||||||
- `total`: The grand total of the cart, including all line items, shipping methods, taxes, and discounts.
|
- `total`: The cart's final total after discounts and credit lines, including taxes.
|
||||||
- `subtotal`: The cart's total excluding taxes, including promotions.
|
- `subtotal`: The cart's subtotal before discounts, excluding taxes. Calculated as the sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
- `tax_total`: The total tax amount applied to the cart.
|
- `tax_total`: The cart's tax total after discounts. Calculated as the sum of `item_tax_total` and `shipping_tax_total`.
|
||||||
- `discount_total`: The total amount of discounts applied to the cart.
|
- `discount_total`: The total amount of discounts applied to the cart, including the tax portion of discounts.
|
||||||
- `discount_subtotal`: The total amount of discounts applied to the cart's subtotal.
|
- `discount_subtotal`: The total amount of discounts applied to the cart's subtotal (excluding tax portion). Used in the final total calculation.
|
||||||
- `discount_tax_total`: The total amount of discounts applied to the cart's tax.
|
- `discount_tax_total`: The total amount of discounts applied to the cart's tax. Represents the tax portion of discounts.
|
||||||
- `original_total`: The cart's total including taxes, excluding promotions.
|
- `original_total`: The cart's total before discounts, including taxes. Calculated as the sum of `original_item_total` and `original_shipping_total`.
|
||||||
- `original_tax_total`: The cart items' tax total including promotions.
|
- `original_tax_total`: The cart's tax total before discounts. Calculated as the sum of `original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
- `item_total`: The cart items' total including taxes and promotions.
|
- `item_total`: The sum of all line items' totals after discounts, including taxes.
|
||||||
- `item_subtotal`: The cart items' total excluding taxes, including promotions.
|
- `item_subtotal`: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
- `item_tax_total`: The cart items' tax total including promotions.
|
- `item_tax_total`: The sum of all line items' tax totals after discounts.
|
||||||
- `original_item_total`: The cart items' total including taxes, excluding promotions.
|
- `original_item_total`: The sum of all line items' original totals before discounts, including taxes.
|
||||||
- `original_item_subtotal`: The cart items' total excluding taxes, including promotions.
|
- `original_item_subtotal`: The sum of all line items' original subtotals before discounts, excluding taxes.
|
||||||
- `original_item_tax_total`: The cart items' tax total excluding promotions.
|
- `original_item_tax_total`: The sum of all line items' original tax totals before discounts.
|
||||||
- `shipping_total`: The cart's shipping total including taxes and promotions.
|
- `shipping_total`: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
- `shipping_subtotal`: The cart's shipping total excluding taxes, including promotions.
|
- `shipping_subtotal`: The sum of all shipping methods' subtotals before discounts, excluding taxes.
|
||||||
- `shipping_tax_total`: The total taxes applied to the cart's shipping amount.
|
- `shipping_tax_total`: The sum of all shipping methods' tax totals after discounts.
|
||||||
- `original_shipping_tax_total`: The total taxes applied to the cart's shipping amount, excluding promotions.
|
- `original_shipping_tax_total`: The sum of all shipping methods' original tax totals before discounts.
|
||||||
- `original_shipping_subtotal`: The cart's shipping total excluding taxes, including promotions.
|
- `original_shipping_subtotal`: The sum of all shipping methods' original subtotals before discounts, excluding taxes.
|
||||||
- `original_shipping_total`: The cart's shipping total including taxes, excluding promotions.
|
- `original_shipping_total`: The sum of all shipping methods' original totals before discounts, including taxes.
|
||||||
- `credit_line_subtotal`: The subtotal of the credit line applied to the cart.
|
- `credit_line_subtotal`: The subtotal of credit lines applied to the cart, excluding taxes.
|
||||||
- `credit_line_tax_total`: The total tax amount applied to the credit line.
|
- `credit_line_tax_total`: The tax total of credit lines applied to the cart.
|
||||||
- `credit_line_total`: The total amount of the credit line applied to the cart.
|
- `credit_line_total`: The total amount of credit lines applied to the cart, including taxes. Subtracted from the final total.
|
||||||
|
|
||||||
### Cart Line Item Totals
|
### Cart Line Item Totals
|
||||||
|
|
||||||
The `items` array in the `cart` object contains total fields for each line item:
|
The `items` array in the `cart` object contains total fields for each line item:
|
||||||
|
|
||||||
- `unit_price`: The price of a single unit of the line item. This field is not calculated and is stored in the database.
|
- `unit_price`: The price of a single unit of the line item. This field is not calculated and is stored in the database.
|
||||||
- `subtotal`: The total price of the line item before any discounts or taxes.
|
- `subtotal`: The line item's subtotal before discounts, excluding taxes.
|
||||||
- `total`: The total price of the line item after applying discounts and taxes.
|
- `total`: The line item's total after discounts, including taxes.
|
||||||
- `original_total`: The total price of the line item before any discounts.
|
- `original_total`: The line item's original total before discounts, including taxes.
|
||||||
- `discount_total`: The total amount of discounts applied to the line item.
|
- `discount_total`: The total amount of discounts applied to the line item, including the tax portion of discounts.
|
||||||
- `discount_subtotal`: The total amount of discounts applied to the line item's subtotal.
|
- `discount_subtotal`: The total amount of discounts applied to the line item's subtotal (excluding tax portion).
|
||||||
- `discount_tax_total`: The total amount of discounts applied to the line item's tax.
|
- `discount_tax_total`: The total amount of discounts applied to the line item's tax. Represents the tax portion of discounts.
|
||||||
- `tax_total`: The total tax amount applied to the line item.
|
- `tax_total`: The line item's tax total after discounts.
|
||||||
- `original_tax_total`: The total tax amount applied to the line item before any discounts.
|
- `original_tax_total`: The line item's original tax total before discounts.
|
||||||
|
|
||||||
### Cart Shipping Method Totals
|
### Cart Shipping Method Totals
|
||||||
|
|
||||||
The `shipping_methods` array in the `cart` object contains total fields for each shipping method:
|
The `shipping_methods` array in the `cart` object contains total fields for each shipping method:
|
||||||
|
|
||||||
- `amount`: The amount charged for the shipping method. This field is not calculated and is stored in the database.
|
- `amount`: The amount charged for the shipping method. This field is not calculated and is stored in the database.
|
||||||
- `subtotal`: The total price of the shipping method before any discounts or taxes.
|
- `subtotal`: The shipping method's subtotal before discounts, excluding taxes.
|
||||||
- `total`: The total price of the shipping method after applying discounts and taxes.
|
- `total`: The shipping method's total after discounts, including taxes.
|
||||||
- `original_total`: The total price of the shipping method before any discounts.
|
- `original_total`: The shipping method's original total before discounts, including taxes.
|
||||||
- `discount_total`: The total amount of discounts applied to the shipping method.
|
- `discount_total`: The total amount of discounts applied to the shipping method, including the tax portion of discounts.
|
||||||
- `discount_subtotal`: The total amount of discounts applied to the shipping method's subtotal.
|
- `discount_subtotal`: The total amount of discounts applied to the shipping method's subtotal (excluding tax portion).
|
||||||
- `discount_tax_total`: The total amount of discounts applied to the shipping method's tax.
|
- `discount_tax_total`: The total amount of discounts applied to the shipping method's tax. Represents the tax portion of discounts.
|
||||||
- `tax_total`: The total tax amount applied to the shipping method.
|
- `tax_total`: The shipping method's tax total after discounts.
|
||||||
- `original_tax_total`: The total tax amount applied to the shipping method before any discounts.
|
- `original_tax_total`: The shipping method's original tax total before discounts.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -205,26 +205,26 @@ The returned `order` object will look like this:
|
|||||||
|
|
||||||
The order will include the following total fields:
|
The order will include the following total fields:
|
||||||
|
|
||||||
- `total`: The grand total of the order, including all line items, shipping methods, taxes, and discounts.
|
- `total`: The order's final total after discounts and credit lines, including taxes.
|
||||||
- `subtotal`: The order's total excluding taxes, including promotions.
|
- `subtotal`: The order's subtotal before discounts, excluding taxes. Calculated as the sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
- `tax_total`: The order's tax total including promotions.
|
- `tax_total`: The order's tax total after discounts. Calculated as the sum of `item_tax_total` and `shipping_tax_total`.
|
||||||
- `original_total`: The order's total including taxes, excluding promotions.
|
- `original_total`: The order's total before discounts, including taxes. Calculated as the sum of `original_item_total` and `original_shipping_total`.
|
||||||
- `original_subtotal`: The order's total excluding taxes, including promotions.
|
- `original_subtotal`: The order's subtotal before discounts, excluding taxes. Calculated as the sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
- `original_tax_total`: The order's tax total excluding promotions.
|
- `original_tax_total`: The order's tax total before discounts. Calculated as the sum of `original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
- `discount_total`: The order's discount or promotions total.
|
- `discount_total`: The total amount of discounts applied to the order, including the tax portion of discounts.
|
||||||
- `discount_tax_total`: The tax total of the order's discount or promotion.
|
- `discount_tax_total`: The total amount of discounts applied to the order's tax. Represents the tax portion of discounts.
|
||||||
- `shipping_total`: The order's shipping total including taxes and promotions.
|
- `shipping_total`: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
- `shipping_subtotal`: The order's shipping total excluding taxes, including promotions.
|
- `shipping_subtotal`: The sum of all shipping methods' subtotals before discounts, excluding taxes.
|
||||||
- `shipping_tax_total`: The tax total of the order's shipping.
|
- `shipping_tax_total`: The sum of all shipping methods' tax totals after discounts.
|
||||||
- `original_shipping_total`: The order's shipping total including taxes, excluding promotions.
|
- `original_shipping_total`: The sum of all shipping methods' original totals before discounts, including taxes.
|
||||||
- `original_shipping_subtotal`: The order's shipping total excluding taxes, including promotions.
|
- `original_shipping_subtotal`: The sum of all shipping methods' original subtotals before discounts, excluding taxes.
|
||||||
- `original_shipping_tax_total`: The tax total of the order's shipping excluding promotions.
|
- `original_shipping_tax_total`: The sum of all shipping methods' original tax totals before discounts.
|
||||||
- `item_total`: The total of all line items in the order, including taxes and promotions.
|
- `item_total`: The sum of all line items' totals after discounts, including taxes.
|
||||||
- `item_tax_total`: The tax total of all line items in the order, including promotions.
|
- `item_tax_total`: The sum of all line items' tax totals after discounts.
|
||||||
- `item_subtotal`: The subtotal of all line items in the order, excluding taxes, including promotions.
|
- `item_subtotal`: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
- `original_item_total`: The total of all line items in the order, including taxes, excluding promotions.
|
- `original_item_total`: The sum of all line items' original totals before discounts, including taxes.
|
||||||
- `original_item_tax_total`: The tax total of all line items in the order, excluding promotions.
|
- `original_item_tax_total`: The sum of all line items' original tax totals before discounts.
|
||||||
- `original_item_subtotal`: The subtotal of all line items in the order, excluding taxes, including promotions.
|
- `original_item_subtotal`: The sum of all line items' original subtotals before discounts, excluding taxes.
|
||||||
- `gift_card_total`: The total amount of gift cards applied to the order.
|
- `gift_card_total`: The total amount of gift cards applied to the order.
|
||||||
- `gift_card_tax_total`: The tax total of the gift cards applied to the order.
|
- `gift_card_tax_total`: The tax total of the gift cards applied to the order.
|
||||||
|
|
||||||
@@ -233,14 +233,14 @@ The order will include the following total fields:
|
|||||||
The `items` array in the `order` object contains total fields for each line item:
|
The `items` array in the `order` object contains total fields for each line item:
|
||||||
|
|
||||||
- `unit_price`: The price of a single unit of the line item. This field is not calculated and is stored in the database.
|
- `unit_price`: The price of a single unit of the line item. This field is not calculated and is stored in the database.
|
||||||
- `subtotal`: The total price of the line item before any discounts or taxes.
|
- `subtotal`: The line item's subtotal before discounts, excluding taxes.
|
||||||
- `total`: The total price of the line item after applying discounts and taxes.
|
- `total`: The line item's total after discounts, including taxes.
|
||||||
- `original_total`: The total price of the line item before any discounts.
|
- `original_total`: The line item's original total before discounts, including taxes.
|
||||||
- `discount_total`: The total amount of discounts applied to the line item.
|
- `discount_total`: The total amount of discounts applied to the line item, including the tax portion of discounts.
|
||||||
- `discount_subtotal`: The total amount of discounts applied to the line item's subtotal.
|
- `discount_subtotal`: The total amount of discounts applied to the line item's subtotal (excluding tax portion).
|
||||||
- `discount_tax_total`: The total amount of discounts applied to the line item's tax.
|
- `discount_tax_total`: The total amount of discounts applied to the line item's tax. Represents the tax portion of discounts.
|
||||||
- `tax_total`: The total tax amount applied to the line item.
|
- `tax_total`: The line item's tax total after discounts.
|
||||||
- `original_tax_total`: The total tax amount applied to the line item before any discounts.
|
- `original_tax_total`: The line item's original tax total before discounts.
|
||||||
- `refundable_total_per_unit`: The total amount that can be refunded per unit of the line item.
|
- `refundable_total_per_unit`: The total amount that can be refunded per unit of the line item.
|
||||||
- `refundable_total`: The total amount that can be refunded for the line item.
|
- `refundable_total`: The total amount that can be refunded for the line item.
|
||||||
- `fulfilled_total`: The total amount of the line item that has been fulfilled.
|
- `fulfilled_total`: The total amount of the line item that has been fulfilled.
|
||||||
@@ -257,14 +257,14 @@ The `items` array in the `order` object contains total fields for each line item
|
|||||||
The `shipping_methods` array in the `order` object contains total fields for each shipping method:
|
The `shipping_methods` array in the `order` object contains total fields for each shipping method:
|
||||||
|
|
||||||
- `amount`: The amount charged for the shipping method. This field is not calculated and is stored in the database.
|
- `amount`: The amount charged for the shipping method. This field is not calculated and is stored in the database.
|
||||||
- `subtotal`: The total price of the shipping method before any discounts or taxes.
|
- `subtotal`: The shipping method's subtotal before discounts, excluding taxes.
|
||||||
- `total`: The total price of the shipping method after applying discounts and taxes.
|
- `total`: The shipping method's total after discounts, including taxes.
|
||||||
- `original_total`: The total price of the shipping method before any discounts.
|
- `original_total`: The shipping method's original total before discounts, including taxes.
|
||||||
- `discount_total`: The total amount of discounts applied to the shipping method.
|
- `discount_total`: The total amount of discounts applied to the shipping method, including the tax portion of discounts.
|
||||||
- `discount_subtotal`: The total amount of discounts applied to the shipping method's subtotal.
|
- `discount_subtotal`: The total amount of discounts applied to the shipping method's subtotal (excluding tax portion).
|
||||||
- `discount_tax_total`: The total amount of discounts applied to the shipping method's tax.
|
- `discount_tax_total`: The total amount of discounts applied to the shipping method's tax. Represents the tax portion of discounts.
|
||||||
- `tax_total`: The total tax amount applied to the shipping method.
|
- `tax_total`: The shipping method's tax total after discounts.
|
||||||
- `original_tax_total`: The total tax amount applied to the shipping method before any discounts.
|
- `original_tax_total`: The shipping method's original tax total before discounts.
|
||||||
|
|
||||||
### Order Summary Totals
|
### Order Summary Totals
|
||||||
|
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ The fields that are most commonly used are:
|
|||||||
`subtotal`
|
`subtotal`
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
<Table.Cell>
|
<Table.Cell>
|
||||||
The cart's subtotal excluding taxes and including items, shipping, and discounts.
|
The cart's subtotal before discounts, excluding taxes. Calculated as the sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
</Table.Row>
|
</Table.Row>
|
||||||
<Table.Row>
|
<Table.Row>
|
||||||
@@ -43,7 +43,7 @@ The fields that are most commonly used are:
|
|||||||
`discount_total`
|
`discount_total`
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
<Table.Cell>
|
<Table.Cell>
|
||||||
The total discounts or promotions applied to the cart.
|
The total amount of discounts applied to the cart, including the tax portion of discounts.
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
</Table.Row>
|
</Table.Row>
|
||||||
<Table.Row>
|
<Table.Row>
|
||||||
@@ -51,7 +51,7 @@ The fields that are most commonly used are:
|
|||||||
`shipping_total`
|
`shipping_total`
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
<Table.Cell>
|
<Table.Cell>
|
||||||
The total shipping cost.
|
The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
</Table.Row>
|
</Table.Row>
|
||||||
<Table.Row>
|
<Table.Row>
|
||||||
@@ -59,7 +59,7 @@ The fields that are most commonly used are:
|
|||||||
`tax_total`
|
`tax_total`
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
<Table.Cell>
|
<Table.Cell>
|
||||||
The total tax amount.
|
The cart's tax total after discounts. Calculated as the sum of `item_tax_total` and `shipping_tax_total`.
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
</Table.Row>
|
</Table.Row>
|
||||||
<Table.Row>
|
<Table.Row>
|
||||||
@@ -67,7 +67,7 @@ The fields that are most commonly used are:
|
|||||||
`total`
|
`total`
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
<Table.Cell>
|
<Table.Cell>
|
||||||
The total amount of the cart including all taxes, shipping, and discounts.
|
The cart's final total after discounts and credit lines, including taxes.
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
</Table.Row>
|
</Table.Row>
|
||||||
</Table.Body>
|
</Table.Body>
|
||||||
|
|||||||
@@ -178,7 +178,7 @@ An order has various fields for the order totals, which you can check out in the
|
|||||||
`subtotal`
|
`subtotal`
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
<Table.Cell>
|
<Table.Cell>
|
||||||
The order's subtotal excluding taxes, and including total of items, shipping, and discounts.
|
The order's subtotal before discounts, excluding taxes. Calculated as the sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
</Table.Row>
|
</Table.Row>
|
||||||
<Table.Row>
|
<Table.Row>
|
||||||
@@ -186,7 +186,7 @@ An order has various fields for the order totals, which you can check out in the
|
|||||||
`discount_total`
|
`discount_total`
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
<Table.Cell>
|
<Table.Cell>
|
||||||
The total discounts or promotions applied to the order.
|
The total amount of discounts applied to the order, including the tax portion of discounts.
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
</Table.Row>
|
</Table.Row>
|
||||||
<Table.Row>
|
<Table.Row>
|
||||||
@@ -194,7 +194,7 @@ An order has various fields for the order totals, which you can check out in the
|
|||||||
`shipping_total`
|
`shipping_total`
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
<Table.Cell>
|
<Table.Cell>
|
||||||
The total shipping cost.
|
The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
</Table.Row>
|
</Table.Row>
|
||||||
<Table.Row>
|
<Table.Row>
|
||||||
@@ -202,7 +202,7 @@ An order has various fields for the order totals, which you can check out in the
|
|||||||
`tax_total`
|
`tax_total`
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
<Table.Cell>
|
<Table.Cell>
|
||||||
The total tax amount.
|
The order's tax total after discounts. Calculated as the sum of `item_tax_total` and `shipping_tax_total`.
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
</Table.Row>
|
</Table.Row>
|
||||||
<Table.Row>
|
<Table.Row>
|
||||||
@@ -210,7 +210,7 @@ An order has various fields for the order totals, which you can check out in the
|
|||||||
`total`
|
`total`
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
<Table.Cell>
|
<Table.Cell>
|
||||||
The total amount of the order including all taxes, shipping, and discounts.
|
The order's final total after discounts and credit lines, including taxes.
|
||||||
</Table.Cell>
|
</Table.Cell>
|
||||||
</Table.Row>
|
</Table.Row>
|
||||||
</Table.Body>
|
</Table.Body>
|
||||||
|
|||||||
@@ -91,59 +91,59 @@
|
|||||||
* original_item_total:
|
* original_item_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_item_total
|
* 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:
|
* original_item_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_item_subtotal
|
* 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:
|
* original_item_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_item_tax_total
|
* 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:
|
* item_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_total
|
* title: item_total
|
||||||
* description: The cart's item total.
|
* description: The sum of all line items' totals after discounts, including taxes.
|
||||||
* item_subtotal:
|
* item_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_subtotal
|
* title: item_subtotal
|
||||||
* description: The cart's item subtotal.
|
* description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
* item_tax_total:
|
* item_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_tax_total
|
* title: item_tax_total
|
||||||
* description: The cart's item tax total.
|
* description: The sum of all line items' tax totals after discounts.
|
||||||
* original_total:
|
* original_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_total
|
* 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:
|
* original_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_subtotal
|
* 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:
|
* original_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_tax_total
|
* 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:
|
* total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: total
|
* title: total
|
||||||
* description: The cart's total.
|
* description: The cart's final total after discounts and credit lines, including taxes.
|
||||||
* subtotal:
|
* subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: subtotal
|
* 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:
|
* tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: tax_total
|
* 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:
|
* discount_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_total
|
* 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:
|
* discount_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_tax_total
|
* 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:
|
* gift_card_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: gift_card_total
|
* title: gift_card_total
|
||||||
@@ -155,27 +155,27 @@
|
|||||||
* shipping_total:
|
* shipping_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: shipping_total
|
* title: shipping_total
|
||||||
* description: The cart's shipping total.
|
* description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
* shipping_subtotal:
|
* shipping_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: shipping_subtotal
|
* title: shipping_subtotal
|
||||||
* description: The cart's shipping subtotal.
|
* description: The sum of all shipping methods' subtotals before discounts, excluding taxes.
|
||||||
* shipping_tax_total:
|
* shipping_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: shipping_tax_total
|
* 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:
|
* original_shipping_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_shipping_total
|
* 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:
|
* original_shipping_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_shipping_subtotal
|
* 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:
|
* original_shipping_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_shipping_tax_total
|
* 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.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
@@ -145,47 +145,47 @@
|
|||||||
* original_total:
|
* original_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_total
|
* title: original_total
|
||||||
* description: The item's original total.
|
* description: The line item's original total before discounts, including taxes.
|
||||||
* original_subtotal:
|
* original_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_subtotal
|
* title: original_subtotal
|
||||||
* description: The item's original subtotal.
|
* description: The line item's original subtotal before discounts, excluding taxes.
|
||||||
* original_tax_total:
|
* original_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_tax_total
|
* title: original_tax_total
|
||||||
* description: The item's original tax total.
|
* description: The line item's original tax total before discounts.
|
||||||
* item_total:
|
* item_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_total
|
* title: item_total
|
||||||
* description: The item's item total.
|
* description: The line item's total after discounts, including taxes.
|
||||||
* item_subtotal:
|
* item_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_subtotal
|
* title: item_subtotal
|
||||||
* description: The item's item subtotal.
|
* description: The line item's subtotal before discounts, excluding taxes.
|
||||||
* item_tax_total:
|
* item_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_tax_total
|
* title: item_tax_total
|
||||||
* description: The item's item tax total.
|
* description: The line item's tax total after discounts.
|
||||||
* total:
|
* total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: total
|
* title: total
|
||||||
* description: The item's total.
|
* description: The line item's total after discounts, including taxes.
|
||||||
* subtotal:
|
* subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: subtotal
|
* title: subtotal
|
||||||
* description: The item's subtotal.
|
* description: The line item's subtotal before discounts, excluding taxes.
|
||||||
* tax_total:
|
* tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: tax_total
|
* title: tax_total
|
||||||
* description: The item's tax total.
|
* description: The line item's tax total after discounts.
|
||||||
* discount_total:
|
* discount_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_total
|
* title: discount_total
|
||||||
* description: The item's discount total.
|
* description: The total amount of discounts applied to the line item, including the tax portion of discounts.
|
||||||
* discount_tax_total:
|
* discount_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_tax_total
|
* title: discount_tax_total
|
||||||
* description: The item's discount tax total.
|
* description: The total amount of discounts applied to the line item's tax. Represents the tax portion of discounts.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
@@ -74,35 +74,35 @@
|
|||||||
* original_total:
|
* original_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_total
|
* title: original_total
|
||||||
* description: The shipping method's total including taxes, excluding promotions.
|
* description: The shipping method's original total before discounts, including taxes.
|
||||||
* original_subtotal:
|
* original_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_subtotal
|
* title: original_subtotal
|
||||||
* description: The shipping method's total excluding taxes, including promotions.
|
* description: The shipping method's original subtotal before discounts, excluding taxes.
|
||||||
* original_tax_total:
|
* original_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_tax_total
|
* title: original_tax_total
|
||||||
* description: The total taxes applied on the shipping method's amount including promotions.
|
* description: The shipping method's original tax total before discounts.
|
||||||
* total:
|
* total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: total
|
* title: total
|
||||||
* description: The shipping method's total amount including taxes and promotions.
|
* description: The shipping method's total after discounts, including taxes.
|
||||||
* subtotal:
|
* subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: subtotal
|
* title: subtotal
|
||||||
* description: The shipping method's total amount excluding taxes, including promotions.
|
* description: The shipping method's subtotal before discounts, excluding taxes.
|
||||||
* tax_total:
|
* tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: tax_total
|
* title: tax_total
|
||||||
* description: The total taxes applied on the shipping method's amount including promotions.
|
* description: The shipping method's tax total after discounts.
|
||||||
* discount_total:
|
* discount_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_total
|
* title: discount_total
|
||||||
* description: The total amount discounted.
|
* description: The total amount of discounts applied to the shipping method, including the tax portion of discounts.
|
||||||
* discount_tax_total:
|
* discount_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_tax_total
|
* title: discount_tax_total
|
||||||
* description: The taxes applied on the discounted amount.
|
* description: The total amount of discounts applied to the shipping method's tax. Represents the tax portion of discounts.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
@@ -154,59 +154,59 @@
|
|||||||
* original_item_total:
|
* original_item_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_item_total
|
* title: original_item_total
|
||||||
* description: The total of the order's items including taxes, excluding promotions.
|
* description: The sum of all line items' original totals before discounts, including taxes.
|
||||||
* original_item_subtotal:
|
* original_item_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_item_subtotal
|
* title: original_item_subtotal
|
||||||
* description: The total of the order's items excluding taxes, including promotions.
|
* description: The sum of all line items' original subtotals before discounts, excluding taxes.
|
||||||
* original_item_tax_total:
|
* original_item_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_item_tax_total
|
* title: original_item_tax_total
|
||||||
* description: The tax total of the order's items excluding promotions.
|
* description: The sum of all line items' original tax totals before discounts.
|
||||||
* item_total:
|
* item_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_total
|
* title: item_total
|
||||||
* description: The total of the order's items including taxes and promotions.
|
* description: The sum of all line items' totals after discounts, including taxes.
|
||||||
* item_subtotal:
|
* item_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_subtotal
|
* title: item_subtotal
|
||||||
* description: The total of the order's items excluding taxes, including promotions.
|
* description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
* item_tax_total:
|
* item_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_tax_total
|
* title: item_tax_total
|
||||||
* description: The tax total of the order's items including promotions.
|
* description: The sum of all line items' tax totals after discounts.
|
||||||
* original_total:
|
* original_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_total
|
* title: original_total
|
||||||
* description: The order's total excluding promotions, including taxes.
|
* description: The order's total before discounts, including taxes. Calculated as the sum of `original_item_total` and `original_shipping_total`.
|
||||||
* original_subtotal:
|
* original_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_subtotal
|
* title: original_subtotal
|
||||||
* description: The order's total excluding taxes, including promotions.
|
* description: The order's subtotal before discounts, excluding taxes. Calculated as the sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
* original_tax_total:
|
* original_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_tax_total
|
* title: original_tax_total
|
||||||
* description: The order's tax total, excluding promotions.
|
* description: The order's tax total before discounts. Calculated as the sum of `original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
* total:
|
* total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: total
|
* title: total
|
||||||
* description: The order's total including taxes and promotions.
|
* description: The order's final total after discounts and credit lines, including taxes.
|
||||||
* subtotal:
|
* subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: subtotal
|
* title: subtotal
|
||||||
* description: The order's total excluding taxes, including promotions.
|
* description: The order's subtotal before discounts, excluding taxes. Calculated as the sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
* tax_total:
|
* tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: tax_total
|
* title: tax_total
|
||||||
* description: The order's tax total including promotions.
|
* description: The order's tax total after discounts. Calculated as the sum of `item_tax_total` and `shipping_tax_total`.
|
||||||
* discount_total:
|
* discount_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_total
|
* title: discount_total
|
||||||
* description: The order's discount or promotions total.
|
* description: The total amount of discounts applied to the order, including the tax portion of discounts.
|
||||||
* discount_tax_total:
|
* discount_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_tax_total
|
* title: discount_tax_total
|
||||||
* description: The tax total of order's discount or promotion.
|
* description: The total amount of discounts applied to the order's tax. Represents the tax portion of discounts.
|
||||||
* gift_card_total:
|
* gift_card_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: gift_card_total
|
* title: gift_card_total
|
||||||
@@ -218,27 +218,27 @@
|
|||||||
* shipping_total:
|
* shipping_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: shipping_total
|
* title: shipping_total
|
||||||
* description: The order's shipping total including taxes and promotions.
|
* description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
* shipping_subtotal:
|
* shipping_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: shipping_subtotal
|
* title: shipping_subtotal
|
||||||
* description: The order's shipping total excluding taxes, including promotions.
|
* description: The sum of all shipping methods' subtotals before discounts, excluding taxes.
|
||||||
* shipping_tax_total:
|
* shipping_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: shipping_tax_total
|
* title: shipping_tax_total
|
||||||
* description: The tax total of the order's shipping.
|
* description: The sum of all shipping methods' tax totals after discounts.
|
||||||
* original_shipping_total:
|
* original_shipping_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_shipping_total
|
* title: original_shipping_total
|
||||||
* description: The order's shipping total including taxes, excluding promotions.
|
* description: The sum of all shipping methods' original totals before discounts, including taxes.
|
||||||
* original_shipping_subtotal:
|
* original_shipping_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_shipping_subtotal
|
* title: original_shipping_subtotal
|
||||||
* description: The order's shipping total excluding taxes, including promotions.
|
* description: The sum of all shipping methods' original subtotals before discounts, excluding taxes.
|
||||||
* original_shipping_tax_total:
|
* original_shipping_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_shipping_tax_total
|
* title: original_shipping_tax_total
|
||||||
* description: The tax total of the order's shipping excluding promotions.
|
* description: The sum of all shipping methods' original tax totals before discounts.
|
||||||
* status:
|
* status:
|
||||||
* type: string
|
* type: string
|
||||||
* title: status
|
* title: status
|
||||||
@@ -246,15 +246,15 @@
|
|||||||
* credit_line_total:
|
* credit_line_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: credit_line_total
|
* title: credit_line_total
|
||||||
* description: The order's credit line total.
|
* description: The total amount of credit lines applied to the order, including taxes. Subtracted from the final total.
|
||||||
* item_discount_total:
|
* item_discount_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_discount_total
|
* title: item_discount_total
|
||||||
* description: The total discount amount applied on the order's items.
|
* description: The sum of all discounts applied to line items, including the tax portion of discounts.
|
||||||
* shipping_discount_total:
|
* shipping_discount_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: shipping_discount_total
|
* title: shipping_discount_total
|
||||||
* description: The total discount amount applied on the order's shipping.
|
* description: The sum of all discounts applied to shipping methods, including the tax portion of discounts.
|
||||||
* custom_display_id:
|
* custom_display_id:
|
||||||
* type: string
|
* type: string
|
||||||
* title: custom_display_id
|
* title: custom_display_id
|
||||||
|
|||||||
@@ -168,47 +168,47 @@
|
|||||||
* original_total:
|
* original_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_total
|
* title: original_total
|
||||||
* description: The item's total including taxes, excluding promotions.
|
* description: The line item's original total before discounts, including taxes.
|
||||||
* original_subtotal:
|
* original_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_subtotal
|
* title: original_subtotal
|
||||||
* description: The item's total excluding taxes, including promotions.
|
* description: The line item's original subtotal before discounts, excluding taxes.
|
||||||
* original_tax_total:
|
* original_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_tax_total
|
* title: original_tax_total
|
||||||
* description: The total taxes of the item, excluding promotions.
|
* description: The line item's original tax total before discounts.
|
||||||
* item_total:
|
* item_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_total
|
* title: item_total
|
||||||
* description: The total taxes of the item, including promotions.
|
* description: The line item's total after discounts, including taxes.
|
||||||
* item_subtotal:
|
* item_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_subtotal
|
* title: item_subtotal
|
||||||
* description: The item's total excluding taxes, including promotions.
|
* description: The line item's subtotal before discounts, excluding taxes.
|
||||||
* item_tax_total:
|
* item_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_tax_total
|
* title: item_tax_total
|
||||||
* description: The total taxes of the item, including promotions.
|
* description: The line item's tax total after discounts.
|
||||||
* total:
|
* total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: total
|
* title: total
|
||||||
* description: The item's total, including taxes and promotions.
|
* description: The line item's total after discounts, including taxes.
|
||||||
* subtotal:
|
* subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: subtotal
|
* title: subtotal
|
||||||
* description: The item's subtotal excluding taxes, including promotions.
|
* description: The line item's subtotal before discounts, excluding taxes.
|
||||||
* tax_total:
|
* tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: tax_total
|
* title: tax_total
|
||||||
* description: The tax total of the item including promotions.
|
* description: The line item's tax total after discounts.
|
||||||
* discount_total:
|
* discount_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_total
|
* title: discount_total
|
||||||
* description: The total discount amount of the item.
|
* description: The total amount of discounts applied to the line item, including the tax portion of discounts.
|
||||||
* discount_tax_total:
|
* discount_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_tax_total
|
* title: discount_tax_total
|
||||||
* description: The total taxes applied on the discounted amount.
|
* description: The total amount of discounts applied to the line item's tax. Represents the tax portion of discounts.
|
||||||
* refundable_total:
|
* refundable_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: refundable_total
|
* title: refundable_total
|
||||||
|
|||||||
@@ -93,59 +93,59 @@
|
|||||||
* original_item_total:
|
* original_item_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_item_total
|
* title: original_item_total
|
||||||
* description: The cart items' total including taxes, excluding promotions.
|
* description: The sum of all line items' original totals before discounts, including taxes.
|
||||||
* original_item_subtotal:
|
* original_item_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_item_subtotal
|
* title: original_item_subtotal
|
||||||
* description: The cart items' total excluding taxes, including promotions.
|
* description: The sum of all line items' original subtotals before discounts, excluding taxes.
|
||||||
* original_item_tax_total:
|
* original_item_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_item_tax_total
|
* title: original_item_tax_total
|
||||||
* description: The cart items' tax total excluding promotions.
|
* description: The sum of all line items' original tax totals before discounts.
|
||||||
* item_total:
|
* item_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_total
|
* title: item_total
|
||||||
* description: The cart items' total including taxes and promotions.
|
* description: The sum of all line items' totals after discounts, including taxes.
|
||||||
* item_subtotal:
|
* item_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_subtotal
|
* title: item_subtotal
|
||||||
* description: The cart items' total excluding taxes, including promotions.
|
* description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
* item_tax_total:
|
* item_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_tax_total
|
* title: item_tax_total
|
||||||
* description: The cart items' tax total including promotions.
|
* description: The sum of all line items' tax totals after discounts.
|
||||||
* original_total:
|
* original_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_total
|
* title: original_total
|
||||||
* description: The cart's total including taxes, excluding promotions.
|
* description: The cart's total before discounts, including taxes. Calculated as the sum of `original_item_total` and `original_shipping_total`.
|
||||||
* original_subtotal:
|
* original_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_subtotal
|
* title: original_subtotal
|
||||||
* description: The cart's total excluding taxes, including promotions.
|
* description: The cart's subtotal before discounts, excluding taxes. Calculated as the sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
* original_tax_total:
|
* original_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_tax_total
|
* title: original_tax_total
|
||||||
* description: The cart's tax total excluding promotions.
|
* description: The cart's tax total before discounts. Calculated as the sum of `original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
* total:
|
* total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: total
|
* title: total
|
||||||
* description: The cart's total including taxes and promotions.
|
* description: The cart's final total after discounts and credit lines, including taxes.
|
||||||
* subtotal:
|
* subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: subtotal
|
* title: subtotal
|
||||||
* description: The cart's total excluding taxes, including promotions.
|
* description: The cart's subtotal before discounts, excluding taxes. Calculated as the sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
* tax_total:
|
* tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: tax_total
|
* title: tax_total
|
||||||
* description: The cart's tax total including promotions.
|
* description: The cart's tax total after discounts. Calculated as the sum of `item_tax_total` and `shipping_tax_total`.
|
||||||
* discount_total:
|
* discount_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_total
|
* 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:
|
* discount_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_tax_total
|
* title: discount_tax_total
|
||||||
* description: The tax total applied on the discounted amount.
|
* description: The total amount of discounts applied to the cart's tax. Represents the tax portion of discounts.
|
||||||
* gift_card_total:
|
* gift_card_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: gift_card_total
|
* title: gift_card_total
|
||||||
@@ -157,27 +157,27 @@
|
|||||||
* shipping_total:
|
* shipping_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: shipping_total
|
* title: shipping_total
|
||||||
* description: The cart's shipping total including taxes and promotions.
|
* description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
* shipping_subtotal:
|
* shipping_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: shipping_subtotal
|
* title: shipping_subtotal
|
||||||
* description: The cart's shipping total excluding taxes, including promotions.
|
* description: The sum of all shipping methods' subtotals before discounts, excluding taxes.
|
||||||
* shipping_tax_total:
|
* shipping_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: shipping_tax_total
|
* title: shipping_tax_total
|
||||||
* description: The total taxes applied on the cart's shipping amount.
|
* description: The sum of all shipping methods' tax totals after discounts.
|
||||||
* original_shipping_total:
|
* original_shipping_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_shipping_total
|
* title: original_shipping_total
|
||||||
* description: The cart's shipping total including taxes, excluding promotions.
|
* description: The sum of all shipping methods' original totals before discounts, including taxes.
|
||||||
* original_shipping_subtotal:
|
* original_shipping_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_shipping_subtotal
|
* title: original_shipping_subtotal
|
||||||
* description: The cart's shipping total excluding taxes, including promotions.
|
* description: The sum of all shipping methods' original subtotals before discounts, excluding taxes.
|
||||||
* original_shipping_tax_total:
|
* original_shipping_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_shipping_tax_total
|
* title: original_shipping_tax_total
|
||||||
* description: The total taxes applied on the cart's shipping amount.
|
* description: The sum of all shipping methods' original tax totals before discounts.
|
||||||
* promotions:
|
* promotions:
|
||||||
* type: array
|
* type: array
|
||||||
* description: The cart's promotions.
|
* description: The cart's promotions.
|
||||||
|
|||||||
@@ -289,57 +289,57 @@
|
|||||||
* original_total:
|
* original_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_total
|
* title: original_total
|
||||||
* description: The item's total including taxes, excluding promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
* description: The line item's original total before discounts, including taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
* original_subtotal:
|
* original_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_subtotal
|
* title: original_subtotal
|
||||||
* description: The item's total excluding taxes, including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
* description: The line item's original subtotal before discounts, excluding taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
* original_tax_total:
|
* original_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_tax_total
|
* title: original_tax_total
|
||||||
* description: The total taxes of the item excluding promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
* description: The line item's original tax total before discounts. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
* item_total:
|
* item_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_tax_total
|
* title: item_total
|
||||||
* description: The item's total including taxes and promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
* description: The line item's total after discounts, including taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
* item_subtotal:
|
* item_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_subtotal
|
* title: item_subtotal
|
||||||
* description: The item's total excluding taxes, including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
* description: The line item's subtotal before discounts, excluding taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
* item_tax_total:
|
* item_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_tax_total
|
* title: item_tax_total
|
||||||
* description: The total taxes of the item including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
* description: The line item's tax total after discounts. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
* total:
|
* total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: total
|
* title: total
|
||||||
* description: The item's total including taxes and promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
* description: The line item's total after discounts, including taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
* subtotal:
|
* subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: subtotal
|
* title: subtotal
|
||||||
* description: The item's total excluding taxes, including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
* description: The line item's subtotal before discounts, excluding taxes. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
* tax_total:
|
* tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: tax_total
|
* title: tax_total
|
||||||
* description: The total taxes of the item including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
* description: The line item's tax total after discounts. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
* discount_total:
|
* discount_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_total
|
* title: discount_total
|
||||||
* description: The total discount of the item. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
* description: The total amount of discounts applied to the line item, including the tax portion of discounts. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
* discount_tax_total:
|
* discount_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_tax_total
|
* title: discount_tax_total
|
||||||
* description: The total taxes applied on the discounted amount. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
* description: The total amount of discounts applied to the line item's tax. Represents the tax portion of discounts. This field is only available if you expand the `items.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -212,42 +212,42 @@
|
|||||||
* original_total:
|
* original_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_total
|
* title: original_total
|
||||||
* description: The shipping method's total including taxes, excluding promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
* description: The shipping method's original total before discounts, including taxes. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
* original_subtotal:
|
* original_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_subtotal
|
* title: original_subtotal
|
||||||
* description: The shipping method's total excluding taxes, including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
* description: The shipping method's original subtotal before discounts, excluding taxes. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
* original_tax_total:
|
* original_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_tax_total
|
* title: original_tax_total
|
||||||
* description: The total taxes applied on the shipping method's amount including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
* description: The shipping method's original tax total before discounts. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
* total:
|
* total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: total
|
* title: total
|
||||||
* description: The shipping method's total amount including taxes and promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
* description: The shipping method's total after discounts, including taxes. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
* subtotal:
|
* subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: subtotal
|
* title: subtotal
|
||||||
* description: The shipping method's total amount excluding taxes, including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
* description: The shipping method's subtotal before discounts, excluding taxes. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
* tax_total:
|
* tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: tax_total
|
* title: tax_total
|
||||||
* description: The total taxes applied on the shipping method's amount including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
* description: The shipping method's tax total after discounts. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
* discount_total:
|
* discount_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_total
|
* title: discount_total
|
||||||
* description: The total amount discounted. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
* description: The total amount of discounts applied to the shipping method, including the tax portion of discounts. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
* discount_tax_total:
|
* discount_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_tax_total
|
* title: discount_tax_total
|
||||||
* description: The taxes applied on the discounted amount. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
* description: The total amount of discounts applied to the shipping method's tax. Represents the tax portion of discounts. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
||||||
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
* Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -145,59 +145,59 @@
|
|||||||
* original_item_total:
|
* original_item_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_item_total
|
* title: original_item_total
|
||||||
* description: The order items' total including taxes, excluding promotions.
|
* description: The sum of all line items' original totals before discounts, including taxes.
|
||||||
* original_item_subtotal:
|
* original_item_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_item_subtotal
|
* title: original_item_subtotal
|
||||||
* description: The order items' total excluding taxes, including promotions.
|
* description: The sum of all line items' original subtotals before discounts, excluding taxes.
|
||||||
* original_item_tax_total:
|
* original_item_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_item_tax_total
|
* title: original_item_tax_total
|
||||||
* description: The total taxes applied on the order items, excluding promotions.
|
* description: The sum of all line items' original tax totals before discounts.
|
||||||
* item_total:
|
* item_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_total
|
* title: item_total
|
||||||
* description: The order items' total including taxes and promotions.
|
* description: The sum of all line items' totals after discounts, including taxes.
|
||||||
* item_subtotal:
|
* item_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_subtotal
|
* title: item_subtotal
|
||||||
* description: The order items' total excluding taxes, including promotions.
|
* description: The sum of all line items' subtotals before discounts, excluding taxes.
|
||||||
* item_tax_total:
|
* item_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_tax_total
|
* title: item_tax_total
|
||||||
* description: The total taxes applied on the order's items, including promotions.
|
* description: The sum of all line items' tax totals after discounts.
|
||||||
* original_total:
|
* original_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_total
|
* title: original_total
|
||||||
* description: The order's total including taxes, excluding promotions.
|
* description: The order's total before discounts, including taxes. Calculated as the sum of `original_item_total` and `original_shipping_total`.
|
||||||
* original_subtotal:
|
* original_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_subtotal
|
* title: original_subtotal
|
||||||
* description: The order's total excluding taxes, including promotions.
|
* description: The order's subtotal before discounts, excluding taxes. Calculated as the sum of `original_item_subtotal` and `original_shipping_subtotal`.
|
||||||
* original_tax_total:
|
* original_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_tax_total
|
* title: original_tax_total
|
||||||
* description: The total taxes of the order excluding promotions.
|
* description: The order's tax total before discounts. Calculated as the sum of `original_item_tax_total` and `original_shipping_tax_total`.
|
||||||
* total:
|
* total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: total
|
* title: total
|
||||||
* description: The order's total including taxes and promotions.
|
* description: The order's final total after discounts and credit lines, including taxes.
|
||||||
* subtotal:
|
* subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: subtotal
|
* title: subtotal
|
||||||
* description: The order's total excluding taxes, including promotions.
|
* description: The order's subtotal before discounts, excluding taxes. Calculated as the sum of `item_subtotal` and `shipping_subtotal`.
|
||||||
* tax_total:
|
* tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: tax_total
|
* title: tax_total
|
||||||
* description: The tax totals of the order including promotions.
|
* description: The order's tax total after discounts. Calculated as the sum of `item_tax_total` and `shipping_tax_total`.
|
||||||
* discount_total:
|
* discount_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_total
|
* title: discount_total
|
||||||
* description: The order's discount total.
|
* description: The total amount of discounts applied to the order, including the tax portion of discounts.
|
||||||
* discount_tax_total:
|
* discount_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: discount_tax_total
|
* title: discount_tax_total
|
||||||
* description: The total taxes applied on the discounted amount.
|
* description: The total amount of discounts applied to the order's tax. Represents the tax portion of discounts.
|
||||||
* gift_card_total:
|
* gift_card_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: gift_card_total
|
* title: gift_card_total
|
||||||
@@ -209,27 +209,27 @@
|
|||||||
* shipping_total:
|
* shipping_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: shipping_total
|
* title: shipping_total
|
||||||
* description: The order's shipping total including taxes and promotions.
|
* description: The sum of all shipping methods' totals after discounts, including taxes.
|
||||||
* shipping_subtotal:
|
* shipping_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: shipping_subtotal
|
* title: shipping_subtotal
|
||||||
* description: The order's shipping total excluding taxes, including promotions.
|
* description: The sum of all shipping methods' subtotals before discounts, excluding taxes.
|
||||||
* shipping_tax_total:
|
* shipping_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: shipping_tax_total
|
* title: shipping_tax_total
|
||||||
* description: The total taxes of the order's shipping including promotions.
|
* description: The sum of all shipping methods' tax totals after discounts.
|
||||||
* original_shipping_total:
|
* original_shipping_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_shipping_total
|
* title: original_shipping_total
|
||||||
* description: The order's shipping total including taxes, excluding promotions.
|
* description: The sum of all shipping methods' original totals before discounts, including taxes.
|
||||||
* original_shipping_subtotal:
|
* original_shipping_subtotal:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_shipping_subtotal
|
* title: original_shipping_subtotal
|
||||||
* description: The order's shipping total excluding taxes, including promotions.
|
* description: The sum of all shipping methods' original subtotals before discounts, excluding taxes.
|
||||||
* original_shipping_tax_total:
|
* original_shipping_tax_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: original_shipping_tax_total
|
* title: original_shipping_tax_total
|
||||||
* description: The total taxes of the order's shipping excluding promotions.
|
* description: The sum of all shipping methods' original tax totals before discounts.
|
||||||
* customer:
|
* customer:
|
||||||
* $ref: "#/components/schemas/StoreCustomer"
|
* $ref: "#/components/schemas/StoreCustomer"
|
||||||
* transactions:
|
* transactions:
|
||||||
@@ -244,15 +244,15 @@
|
|||||||
* credit_line_total:
|
* credit_line_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: credit_line_total
|
* title: credit_line_total
|
||||||
* description: The order's credit line total.
|
* description: The total amount of credit lines applied to the order, including taxes. Subtracted from the final total.
|
||||||
* item_discount_total:
|
* item_discount_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: item_discount_total
|
* title: item_discount_total
|
||||||
* description: The total discount amount applied on the order's items.
|
* description: The sum of all discounts applied to line items, including the tax portion of discounts.
|
||||||
* shipping_discount_total:
|
* shipping_discount_total:
|
||||||
* type: number
|
* type: number
|
||||||
* title: shipping_discount_total
|
* title: shipping_discount_total
|
||||||
* description: The total discount amount applied on the order's shipping.
|
* description: The sum of all discounts applied to shipping methods, including the tax portion of discounts.
|
||||||
* custom_display_id:
|
* custom_display_id:
|
||||||
* type: string
|
* type: string
|
||||||
* title: custom_display_id
|
* title: custom_display_id
|
||||||
|
|||||||
Reference in new issue
Block a user