post

/estimate

Submit the quote request to retrieve a estimate from the enabled third party tax provider. Estimates are not expected to be persisted by the tax provider.

The following actions can trigger tax estimate requests multiple times during a standard checkout on a BigCommerce storefront, depending on the BigCommerce merchant’s settings.

  • After selecting a Shipping Method during the “Estimate Shipping & Tax” facility on the Cart page.
  • After specifying a Shipping Address during a Checkout.
  • After selecting a Shipping Method during a Checkout.
  • After specifying a Billing Address during a Checkout.

The following actions are not expected to trigger estimate requests.

  • While anonymously browsing a store’s product catalog.
  • On the Cart page prior to a Shopper selecting a Shipping Method via “Estimate Shipping & Tax”.
  • On the Checkout page prior to specifying a Shipping Address.
  • On the Checkout page, when toggling any option related to using the shopper’s Shipping Address as their Billing Address.

The following control panel can also trigger tax estimation requests.

  • Order refund flows.
  • Test connection feature in Tax Settings.

Authorization

basic

Request Parameters

1 Header

Request Body

Estimates may not always contain complete data as these requests will be fired at different stages of the shopper checkout. For example, with the Estimate Shipping & Tax function on the Cart page is not expected to provide any billing address data, but the tax provider will still be expected to return a valid estimate.

Schema
object

A QuoteRequest contains all of the tax relevant items that a shopper is placing an order for divided into documents (represented by an array of 1+ DocumentRequest objects) corresponding to each of the shipping addresses a shopper is sending items to (as multi-address orders may be taxed differently based on shipping address).

$schema: http://json-schema.org/draft-04/schema#
currency_code
string

ISO 4217 3 character currency code that all prices on this request are in.

required
customer
object

If the shopper is a registered customer in the merchants store, basic details for that customer.

required
documents
array[object]

One or more consignments containing items being purchased by the shopper, including shipping and handling fees that are charged for each consignment. Most orders will contain a single consignment (to a single shipping address), however the BigCommerce platform also supports “Multi-address orders” which allow shoppers to place a single order with items shipped to different addresses.

required
id
string

Unique ID of the taxable document (order, cart, quote, etc) this tax quote request is being generated for. Will remain consistent for the lifetime of the entity being estimated.

required
transaction_date
string

ISO 8601 formatted date the shopper placed this order. Dates will be provided in UTC.

1 validation + required

Responses

Noteworthy is that the estimate response does not contain an external ID since there is no expectation that an estimate will result in any persisted tax documents by the tax provider.

1 Example
Schema
object
$schema: http://json-schema.org/draft-04/schema#
documents
array[object]

One or more consignments containing items being purchased by the shopper, including shipping and handling fees that are charged for each consignment. Most orders will contain a single consignment (to a single shipping address), however the BigCommerce platform also supports “Multi-address orders” which allow shoppers to place a single order with items shipped to different addresses.

required
id
string

The unique identifier of the tax quote that was requested. This must match the ID of the requested quote.

required

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
your_server
$$.env
2 variables not set
username
password