POST

Calculate Tax

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Calculates tax for the provided line items.

Tax is calculated for each line item based on the tax region that corresponds to the address provided in lineItems.addressIndex and the tax group in taxGroupId. If no tax region is found for the line item's address then no tax will be calculated for this line item. If no tax group with that taxGroupId is found then the default tax group is used to calculate tax. Call List Default Tax Groups to retrieve a site's default tax groups.

The tax is calculated by a tax calculator app installed on the site. Call List Tax Calculators to see which tax calculators are available. To provide your own tax calculations, use the Tax Calculation service plugin.

The breakdown of calculated tax returned, includes:

  • taxSummary: The overall total tax calculated.
  • taxSummary.aggregatedTaxBreakdown: The total tax calculated for each jurisdiction.
  • lineItemTaxDetails.taxSummary: The total tax calculated for each line item.
  • lineItemTaxDetails.taxBreakdown: The tax calculated for each line item in each jurisdiction.
Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/billing/v1/calculate-tax
Body Params
externalIdstringformat GUID

Optional ID of the entity that tax is being calculated for. For example, a cart ID.

currencystringformat CURRENCY

3-letter currency code in ISO-4217 alphabetic format.

addressesArray <Address>RequiredminItems 1maxItems 3

Array of addresses. Each line item can individually reference the address to apply with lineItems.addressIndex.

lineItemsArray <LineItem>RequiredminItems 1maxItems 300

Line items to calculate tax for.

Response Object
externalIdstringformat GUID

Optional ID of the entity that tax is being calculated for. For example, a cart ID.

currencystringformat CURRENCY

3-letter currency code in ISO-4217 alphabetic format.

addressesArray <Address>minItems 1maxItems 3

Array of addresses. Each line item can individually reference the address to apply with lineItems.addressIndex.

taxSummaryTaxSummary

Summary of the tax calculated.

lineItemTaxDetailsArray <LineItemTaxDetails>minItems 1maxItems 300

Details of each tax applied to each line item.

errorsArray <ApplicationError>minItems 0maxItems 100

Errors that occurred during the tax calculation.

Calculate Tax

Trigger a tax calculation for a given set of line items and their addresses.

Request
cURL
Response
JSON
Errors
400Invalid Argument

There is 1 error with this status code.

428Failed Precondition

There are 3 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?