Skip to content

Commit 4c16ce7

Browse files
committed
Updated API from documentation release
1 parent 7f0d287 commit 4c16ce7

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

api-specs/api/types/cart/updates/CartSetCartTotalTaxAction.raml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,14 @@ displayName: CartSetCartTotalTaxAction
55
discriminatorValue: setCartTotalTax
66
example: !include ../../../examples/Cart/CartSetCartTotalTaxAction.json
77
description: |
8-
Can be used if the Cart has the `ExternalAmount` [TaxMode](ctp:api:type:TaxMode). This update action adds the `taxedPrice` field to the Cart and must be used after any price-affecting change occurs within the Cart.
8+
Can be used if the Cart has the `ExternalAmount` [TaxMode](ctp:api:type:TaxMode). This update action adds the `taxedPrice` field to the Cart. It sets the `totalGross` amount, and Composable Commerce calculates the `totalNet` and `totalTax` values based on the provided `externalTotalGross`.
9+
You must use this update action after any price-affecting change occurs within the Cart.
910
1011
properties:
1112
externalTotalGross:
1213
type: Money
1314
description: |
14-
The Cart's total gross price becoming the `totalGross` field (`totalNet` + taxes) on the Cart's `taxedPrice`.
15+
The total gross amount of the Cart, including tax. This value is used to calculate the `totalNet` and `totalTax` fields of the Cart's `taxedPrice`.
1516
externalTaxPortions?:
1617
type: TaxPortionDraft[]
1718
description: |

0 commit comments

Comments
 (0)