Skip to content

Commit 1a7da72

Browse files
committed
Updated API from documentation release
1 parent ca3c73b commit 1a7da72

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

api-specs/api/types/cart-discount/CartDiscountTotalPriceTarget.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ discriminatorValue: totalPrice
66
example: !include ../../examples/CartDiscount/CartDiscountTotalPriceTarget.json
77
description: |
88
Discount is applied to the total price of the [Cart](ctp:api:type:Cart).
9-
The same percentage of discount applies on the [Cart](ctp:api:type:Cart) or [Order](ctp:api:type:Order) `taxedPrice`.
9+
The same percentage of discount applies on the [Cart](ctp:api:type:Cart) or [Order](ctp:api:type:Order) `taxedPrice` and `taxedShippingPrice`.

api-specs/api/types/cart/Cart.raml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,13 @@ properties:
7272
- For a Cart with `Platform` [TaxMode](ctp:api:type:TaxMode), it is automatically set when a [shipping address is set](ctp:api:type:CartSetShippingAddressAction). For Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode), all Line Items and Custom Line Items must be fully distributed between the Shipping Methods (via `shippingDetails`), otherwise `taxedPrice` is not automatically set.
7373
- For a Cart with `External` [TaxMode](ctp:api:type:TaxMode), it is automatically set when `shippingAddress` and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set. For Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode), all allocations must have their respective tax rates present in `perMethodTaxRate`, otherwise `taxedPrice` is not automatically set.
7474
75-
If a discount applies on `totalPrice`, this field holds the discounted values.
75+
If a discount applies on `totalPrice`, this field holds the proportionally discounted value.
7676
taxedShippingPrice?:
7777
type: TaxedPrice
7878
description: |-
7979
Sum of the `taxedPrice` field of [ShippingInfo](ctp:api:type:ShippingInfo) across all Shipping Methods.
80+
81+
If a discount applies on `totalPrice`, this field holds the proportionally discounted value.
8082
discountOnTotalPrice?:
8183
type: DiscountOnTotalPrice
8284
description: |-

api-specs/api/types/order/Order.raml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,13 @@ properties:
7171
- For `Platform` [TaxMode](ctp:api:type:TaxMode), it is automatically set when a [shipping address is set](ctp:api:type:OrderSetShippingAddressAction).
7272
- For `External` [TaxMode](ctp:api:type:TaxMode), it is automatically set when `shippingAddress` and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.
7373
74-
If a discount applies on `totalPrice`, this field holds the discounted values.
74+
If a discount applies on `totalPrice`, this field holds the proportionally discounted value.
7575
taxedShippingPrice?:
7676
type: TaxedPrice
7777
description: |
7878
Sum of the `taxedPrice` field of [ShippingInfo](ctp:api:type:ShippingInfo) across all Shipping Methods.
79+
80+
If a discount applies on `totalPrice`, this field holds the proportionally discounted value.
7981
discountOnTotalPrice?:
8082
type: DiscountOnTotalPrice
8183
description: |-

0 commit comments

Comments
 (0)