Skip to content

doc(orders): ORDERS-7176 new field comparisonShippingCost in SF Order API #1103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 14, 2025
Merged

doc(orders): ORDERS-7176 new field comparisonShippingCost in SF Order API #1103

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e90f82
doc(orders): ORDERS-7176 new field comparisonShippingCost in SF Order…
donald-nguyen-bc Oct 8, 2025
f450b84
doc(orders): ORDERS-7176 fix some typos
donald-nguyen-bc Oct 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions reference/orders.sf.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,11 +146,18 @@ components:
type: string
description: Shopperʼs provided message for the order.
shippingCostTotal:
type: integer
type: number
shippingCostBeforeDiscount:
type: integer
type: number
description: Estimated total shipping cost before any shipping discounts have been applied.
comparisonShippingCost:
type: number
description: |
The total shipping cost to be shown to shopper in the summary as struck-through.
- If the entered-price and display-price have the same tax setting (e.g.: both are tax-inclusive), this field will be the estimated total shipping cost before any coupons applied (but after automatic promotions applied).
- If the entered-price and display-price have different tax setting (e.g.: one is tax-inclusive, and one is tax-exclusive), this field will be the estimated total shipping cost before any discounts applied, similar to the `shippingCostBeforeDiscount`.
handlingCostTotal:
type: integer
type: number
customerCanBeCreated:
type: boolean
taxes:
Expand Down Expand Up @@ -907,6 +914,15 @@ components:
costTaxClassId:
type: integer
example: 2
shippingCostBeforeDiscount:
type: number
description: Estimated consignment shipping cost before any shipping discounts have been applied.
comparisonShippingCost:
type: number
description: |
The consignment shipping cost to be shown to shopper in the summary as struck-through.
- If the entered-price and display-price have the same tax setting (e.g.: both are tax-inclusive), this field will be the estimated shipping cost before any coupons applied (but after automatic promotions applied).
- If the entered-price and display-price have different tax setting (e.g.: one is tax-inclusive, and one is tax-exclusive), this field will be the estimated shipping cost before any discounts applied, similar to the `shippingCostBeforeDiscount`.
baseHandlingCost:
type: number
example: 0.00
Expand Down Expand Up @@ -958,6 +974,8 @@ components:
costIncTax: 16.7
costTax: 1.2
costTaxClassId: 2
shippingCostBeforeDiscount: 17.5
comparisonShippingCost: 16.5
baseHandlingCost: 0
handlingCostExTax: 0
handlingCostIncTax: 0
Expand Down