Skip to main content
POST
/
commerce
/
catalog
/
storefront
/
tax
/
estimate-order
Error
A valid request URL is required to generate request examples
{
  "itemTaxContexts": [
    {
      "id": "<string>",
      "productCode": "<string>",
      "quantity": 123,
      "tax": 123,
      "shippingTax": 123,
      "duty": 123,
      "taxData": {}
    }
  ],
  "shippingTax": 123,
  "handlingFeeTax": 123,
  "orderTax": 123,
  "taxData": {}
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

application/json

Properties of a taxable order

orderDate
string<date-time>

Date on which the order is/was submitted. Cannot be a future date.

taxContext
object

The context for the tax calculation.

lineItems
object[] | null

List of taxable items.

shippingAmount
number<double>

Shipping Amount rolled up for the order

currencyCode
string | null

The currency code for this order

handlingFee
number<double>

Handling Fee

originalDocumentCode
string | null

The order id of the original order. This can be used to track changes to the order for taxing purposes.

orderId
string | null
orderNumber
integer<int32> | null
originalOrderDate
string<date-time>

The date of the original order. This is used when calculating changes to the Taxable Order, evaluating them at this time rather than the present.

data
object
attributes
object[] | null
shippingDiscounts
object[] | null

The list of historically-applied shipping discounts. The active one will have IsExcluded == false

shippingDiscount
object

Details of the applied discount, including how much the shopper saves if the discount is applied and the coupon code required to redeem the discount, if any.

orderDiscounts
object[] | null

The discount that has been applied to the cart itself. If multiple discounts exist, this is the discount that the system applies because it offers the best savings for the shopper. This is a negative number.

orderDiscount
object

Details of the applied discount, including how much the shopper saves if the discount is applied and the coupon code required to redeem the discount, if any.

handlingDiscounts
object[] | null

The list of historically-applied handling discounts. The active one will have IsExcluded == false

handlingDiscount
object

Details of the applied discount, including how much the shopper saves if the discount is applied and the coupon code required to redeem the discount, if any.

shippingMethodCode
string | null

Code that uniquely identifies the shipping method such as "Ground," "Overnight," or "Digital." The site's shipping settings lists the valid shipping methods specified for this site.

shippingMethodName
string | null

Readable name of the shipping method

taxRequestType
string | null

Used to differentiate between an Order and a Return being used as the source of this Taxable Order

Response

Success

itemTaxContexts
object[] | null

Taxes applied to each item in the order.

shippingTax
number<double>

Rollup shipping tax for this order

handlingFeeTax
number<double>

The handling fee tax amount for this line item

orderTax
number<double>

Rollup tax on the order not including shipping

taxData
object

Storage for any additional/custom tax data.