post

/commit

Submit the quote request to be persisted by the enabled third party tax provider. A commit operation is intended to be submitted once only, when the Order has been confirmed and paid.

Authorization

basic

Request Parameters

1 Header

Request Body

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

OK

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