VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Impostos

Campos de impostos

Referência de todas as propriedades de um objeto de imposto: nomes, descrições, valores padrão e valores aceitos.

Um objeto de imposto tem várias propriedades, representadas por campos. Esses campos controlam como os impostos são calculados, exibidos e aplicados a produtos e pedidos.

Importante

A tabela abaixo mostra todos os campos aceitos em objetos de imposto. Os campos obrigatórios estão marcados com *. Qualquer campo que não esteja na tabela é ignorado se for enviado em uma requisição.

Referência dos campos de imposto

Nome do campoDescriçãoValor padrãoValores aceitos
tax*Nome do impostonenhumstring
tax_id*ID do impostoDefinido automaticamenteinteger
regnumberNúmero de registronenhuminteger
priorityPrioridade do imposto0inteiro positivo
price_includes_taxSe Y, o imposto está incluído no preço do produto; se N, o valor do imposto é somado ao preço do produtoNY, N
display_including_taxExibir o imposto incluído no preço do produtoNY, N
address_typeSe S, as alíquotas dependem do endereço de entrega; se B, dependem do endereço de cobrançaSS, B
statusStatus do imposto: A para ativo, D para desativado, H para ocultoAA, D, H
lang_codeCódigo do idioma do nome do impostoO código do idioma padrão da lojaEN, RU etc.

Exemplo de objeto de imposto

Dica

Ao criar um imposto novo, só o campo tax é obrigatório. Os demais campos usam os valores padrão quando não são informados.

Sobre a prioridade do imposto

Quando vários impostos se aplicam a um produto, eles são calculados em ordem de prioridade (os números maiores são processados primeiro). Isso é importante ao usar cálculo de impostos compostos.

Veja também

Impostos
As rotas das regras de imposto.
Endpoints
As URLs da API de impostos.
Anterior
Paginação de impostos
Próxima
Promoções, cupons e banners
Nesta página
  • Referência dos campos de imposto
  • Exemplo de objeto de imposto
  • Veja também
json
{
  "tax": "Sales Tax",
  "tax_id": 12,
  "regnumber": 987654,
  "priority": 10,
  "price_includes_tax": "N",
  "display_including_tax": "Y",
  "address_type": "S",
  "status": "A",
  "lang_code": "EN"
}