Skip to main content

Managing tax transactions

You can use the Taxes Integration API to create or retrieve tax transactions. Tax transactions contain detailed information about tax calculations, including tax exemption information and taxes applied to an order.

note

In this guide, the code snippets contain {tenant} {env} or {token} properties.

  • Use the target tenant for the {tenant} property.
  • Use the target environment for the {env} property.
  • Use your NewStore token retrieved from the Omnichannel Manager console for the token property.

Creating tax transactions​

As part of the order placement process, tax transactions are created by the NewStore platform for orders that require a tax calculation. A tax transaction will be created by the NewStore platform for:

  • Orders placed via NewStore Associate App
  • Blind returns that are placed via NewStore Associate App
Important

A tax transaction can be created only if the tax calculation settings are configured. For more information, see Configuring tax calculation settings and the Tax calculation API.

When a tax transaction is being created, a tax quotation will be performed for the related order data. The tax quotation is stored within the tax transaction, along with the order data.

A tax transaction will only be created by the NewStore platform for the orders that originated from the NewStore platform that require a tax calculation.

A tax transaction will not be created for referenced returns since the taxes for the items that are being returned are already available in the referenced order.

Retrieving tax transactions for orders placed in the NewStore platform​

A tax transaction can be retrieved for sales and returns if the tax calculations were performed within the NewStore platform. For more details, see Creating tax transactions .

Tax transactions for orders can be retrieved by using the internal order ID of the order:

curl --location 'https://{tenant}.{env}.newstore.net/taxes/transactions/{order_id}' \
--header 'Authorization: Bearer {token}'

Tax transactions for returns can be retrieved by using the internal order and the return ID:

curl --location 'https://{tenant}.{env}.newstore.net/taxes/transactions/{order_id}/returns/{return_id}' \
--header 'Authorization: Bearer {token}'

Related links