Simulate taxes

Simulate taxes for the items in a cart together with freight, for a given destination country and state.

All input and output monetary values for this API are in the local currency (for example, BRL when country is BR).

curl -X POST 'https://product.api.e-cross.tech/ext/taxes' \
  -H 'Authorization: Bearer YOUR_SALES_CHANNEL_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
        {
            "id": "029c31c8-6576-42fb-a846-5144d2efb3a4",
            "skuId": "1",
            "quantity": 1,
            "unitPriceWithDiscount": 180.00
        }
    ],
    "freight": 50,
    "country": "BR",
    "state": "SP"
}'

{
  "fxRate": 5.51,
  "items": [
    {
      "id": "029c31c8-6576-42fb-a846-5144d2efb3a4",
      "skuId": "1",
      "cbsTaxValue": 0,
      "ibsETaxValue": 0,
      "ibsMTaxValue": 0,
      "icmsTaxValue": 31.6,
      "importTaxValue": 0,
      "totalTaxValue": 31.6
    }
  ],
  "totals": {
    "cbsTaxValue": 0,
    "ibsETaxValue": 0,
    "ibsMTaxValue": 0,
    "icmsTaxValue": 31.6,
    "importTaxValue": 0,
    "totalTaxValue": 31.6
  }
}

How authentication works

This endpoint uses the sales channel token authentication model, not the auth token generated with merchant credentials. The bearer token is provided by e-CROSS to the sales channel during the integration process.

Authorization: Bearer YOUR_SALES_CHANNEL_TOKEN

Headers

string

required

Bearer token for the sales channel request. Use the format Bearer YOUR_SALES_CHANNEL_TOKEN.

Request body

array

required

Line items to simulate taxes for together.

Show Item fields

string

required

Unique ID for this line; the same ID is returned in the response for that line.

string

required

SKU identifier on e-CROSS.

number

required

Quantity of the SKU.

number

required

Unit price in local currency after discounts; the amount the customer pays per unit at checkout.

number

required

Freight value for the cart in local currency, without any shipping discount applied.

string

required

ISO 3166-1 alpha-2 destination country code (for example, BR).

string

required

Destination state or region code. For countries where taxes depend on state (for example, Brazil), use the correct two-letter state code (for example, SP).

Response fields

number

required

USD to BRL FX rate used by this API when calculating the response values.

array

required

One entry per request line, in the same order as requested.

Show Item properties

string

required

Line ID from the request.

string

required

SKU ID from the request.

number

required

CBS (Contribuição sobre Bens e Serviços) tax for this line, in local currency.

number

required

IBS-E (Imposto Estadual sobre Bens e Serviços) tax for this line, in local currency.

number

required

IBS-M (Imposto Municipal sobre Bens e Serviços) tax for this line, in local currency.

number

required

Total ICMS (or equivalent domestic sales tax) for this line, in local currency.

number

required

Total import tax for this line, in local currency.

number

required

Total tax for this line: icmsTaxValue + importTaxValue.

object

required

Aggregates for the whole request.

Show Totals properties

number

required

Sum of CBS (Contribuição sobre Bens e Serviços) tax across all lines.

number

required

Sum of IBS-E (Imposto Estadual sobre Bens e Serviços) tax across all lines.

number

required

Sum of IBS-M (Imposto Municipal sobre Bens e Serviços) tax across all lines.

number

required

Sum of icmsTaxValue across all lines.

number

required

Sum of importTaxValue across all lines.

number

required

Sum of totalTaxValue across all lines (equivalently, totals.icmsTaxValue + totals.importTaxValue).

Errors

401 Unauthorized

The request is missing the Authorization header, the bearer format is invalid, or the token is invalid.

Overview

Authentication APIs

Sales Channel APIs

Merchant Catalog APIs

Order APIs

Shipment APIs

Parcel APIs

Sandbox APIs

How authentication works

Headers

Request body

Response fields

Errors

​How authentication works

​Headers

​Request body

​Response fields

​Errors

How authentication works

Headers

Request body

Response fields

Errors