Skip to content

Commit 0b3fd8b

Browse files
authored
docs(checkout): CHECKOUT-9857 Document storefront checkout shipping comparison fields (#1287)
<!-- Ticket number or summary of work --> # [CHECKOUT-9857] ## What changed? Updates the Storefront Checkouts spec (reference/checkouts.sf.yml) for the Get a Checkout response. - checkout_Full: clarify shippingCostBeforeDiscount (total shipping before discounts) and document comparisonShippingCost (total shipping after automatic promotions). - consignment_Full: add shippingCostBeforeDiscount and comparisonShippingCost with the same meanings per consignment. - CheckoutResp example: include the new fields. ## Release notes draft * The [Storefront Checkout API](https://developer.bigcommerce.com/docs/rest-storefront/checkouts#get-a-checkout) response now documents shipping comparison fields so you can show shoppers the right “original” vs. promotional shipping amounts. Checkout and each consignment include **shipping cost before discount** and **shipping cost after automatic promotions**, which makes it easier to display fair pricing and explain savings at checkout. ## Anything else? <img width="1678" height="2062" alt="image" src="https://github.com/user-attachments/assets/bbab3739-17d5-4702-ae64-fc6079a95f9a" /> ping @bigcommerce/team-checkout [CHECKOUT-9857]: https://bigcommercecloud.atlassian.net/browse/CHECKOUT-9857?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
1 parent d78d46d commit 0b3fd8b

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

reference/checkouts.sf.yml

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -897,6 +897,8 @@ components:
897897
cost: 69.94
898898
transitTime: 1 business day
899899
shippingCost: 69.94
900+
shippingCostBeforeDiscount: 69.94
901+
comparisonShippingCost: 64.94
900902
coupons:
901903
- code: S2549JM0Y
902904
couponType: 2
@@ -941,6 +943,7 @@ components:
941943
payments: [{}]
942944
promotions: []
943945
shippingCostBeforeDiscount: 69.94
946+
comparisonShippingCost: 64.94
944947
shippingCostTotal: 69.94
945948
shouldExecuteSpamCheck: false
946949
subtotal: 117.93
@@ -1066,7 +1069,12 @@ components:
10661069
description: Text displayed on the storefront for the promotion.
10671070
shippingCostBeforeDiscount:
10681071
type: number
1069-
description: The shipping cost before discounts are applied.
1072+
description: Total shipping cost for the checkout before discounts are applied.
1073+
format: float
1074+
comparisonShippingCost:
1075+
type: number
1076+
description: Total shipping cost for the checkout after automatic promotions are applied.
1077+
format: float
10701078
shippingCostTotal:
10711079
type: number
10721080
description: Shipping cost before any discounts are applied.
@@ -1447,6 +1455,14 @@ components:
14471455
type: number
14481456
description: The shipping cost for this consignment.
14491457
format: double
1458+
shippingCostBeforeDiscount:
1459+
type: number
1460+
description: This consignment's shipping cost before discounts are applied.
1461+
format: double
1462+
comparisonShippingCost:
1463+
type: number
1464+
description: This consignment's shipping cost after automatic promotions are applied.
1465+
format: double
14501466
lineItemIds:
14511467
type: array
14521468
description: ''

0 commit comments

Comments
 (0)