Updated API from documentation release

commercetools · Jan 25, 2024 · 8242aca · 8242aca
1 parent c640bc7
commit 8242aca
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 6 deletions.
diff --git a/api-specs/api/types/cart/CustomLineItem.raml b/api-specs/api/types/cart/CustomLineItem.raml
@@ -30,7 +30,8 @@ properties:
   taxedPricePortions:
     type: MethodTaxedPrice[]
     description: |-
-      Taxed price of the Shipping Method that is automatically set after `perMethodTaxRate` is set.
+      Total taxed prices based on the quantity of the Custom Line Item assigned to each [Shipping Method](ctp:api:type:ShippingMethod). Only applicable for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
+      Automatically set after `perMethodTaxRate` is set.
   totalPrice:
     type: CentPrecisionMoney
     description: |

diff --git a/api-specs/api/types/cart/LineItem.raml b/api-specs/api/types/cart/LineItem.raml
@@ -75,7 +75,8 @@ properties:
   taxedPricePortions:
     type: MethodTaxedPrice[]
     description: |-
-      Taxed price of the Shipping Method that is automatically set after `perMethodTaxRate` is set.
+      Total taxed prices based on the quantity of Line Item assigned to each [Shipping Method](ctp:api:type:ShippingMethod). Only applicable for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
+      Automatically set after `perMethodTaxRate` is set.
   state:
     type: ItemState[]
     description: |

diff --git a/api-specs/api/types/cart/MethodTaxedPrice.raml b/api-specs/api/types/cart/MethodTaxedPrice.raml
@@ -7,8 +7,8 @@ properties:
   shippingMethodKey:
     type: string
     description: |
-      User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
+      User-defined unique identifier of the [Shipping Method](ctp:api:type:ShippingMethod) in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
   taxedPrice?:
     type: TaxedItemPrice
     description: |
-      Taxed price for the Shipping Method.
+      Total taxed price based on the quantity of the Line Item or Custom Line Item assigned to the Shipping Method identified by `shippingMethodKey`.
diff --git a/api-specs/api/types/message/OrderLineItemDiscountSetMessage.raml b/api-specs/api/types/message/OrderLineItemDiscountSetMessage.raml
@@ -30,4 +30,5 @@ properties:
   taxedPricePortions:
     type: MethodTaxedPrice[]
     description: |
-      Taxed price of the Shipping Methods in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
+      Total taxed prices based on the quantity of Line Item assigned to each [Shipping Method](ctp:api:type:ShippingMethod). Only applicable for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
+      Automatically set after `perMethodTaxRate` is set.
diff --git a/api-specs/api/types/message/payload/OrderLineItemDiscountSetMessagePayload.raml b/api-specs/api/types/message/payload/OrderLineItemDiscountSetMessagePayload.raml
@@ -30,4 +30,5 @@ properties:
   taxedPricePortions:
     type: MethodTaxedPrice[]
     description: |
-      Taxed price of the Shipping Methods in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
+      Total taxed prices based on the quantity of Line Item assigned to each [Shipping Method](ctp:api:type:ShippingMethod). Only applicable for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
+      Automatically set after `perMethodTaxRate` is set.