Cadastro de alíquota usando API

A fórmula da alíquota poderá ser criada utilizando sua API, para isso, você precisará configurá-la para que ela retorne os ajustes necessários e também respeite o modelo de retorno.

No cadastro de alíquotas na plataforma, será necessário ativar a opção Usar API, definir o Tipo de Cálculo e o Tipo de ajuste será definido automaticamente, sendo por item.

Abaixo em Dados da API, será necessário informar a URL da sua API no campo Endpoint. Caso haja necessidade de adicionar alguma informação de autenticação, por exemplo, insira nos campos chave e valor, clicando no botão Adicionar Header.

A sua API criada deve respeitar os métodos disponíveis no formulário de Dados da API, não sendo aceito quaisquer outros métodos que não sejam inclusos na opção do formulário.

Abaixo os exemplos dos objetos de envio e retorno para sua API:

Objeto JSON que será enviado para sua API:

{
  "Id": null,
  "Fechado": false,
  "Cep": 0,
  "Produtos": [
    {
      "PrecoDe": 0.0,
      "PrecoPor": 0.0,
      "ProdutoVarianteId": 0,
      "Quantidade": 0,
      "CentroDistribuicaoId": 0,
      "Sku": null,
      "AjustesProduto": [
                {
                    "Tipo": 0,
                    "Valor": 0.0,
                    "Nome": null
                },
                {
                    "Tipo": 0,
                    "Valor": 0.0,
                    "Nome": null
                }
            ],
      "Remarcado": false,
      "Metadados": {
        "chave": "valor",
        "metadado": "metadado produto"
      }
    }
  ],
  "ValorFrete": 0.0,
  "ValorTotal": 0.0,
  "ContaCorrente": 0.0,
  "FreteEscolhido": {
    "Valor": 0.0,
    "Ajuste": 0.0,
    "Prazo": 0,
    "ValorCotacaoTodos": 0.0
  },
  "Cotacoes": [
    {
      "CotacaoFreteId": null,
      "Nome": null,
      "Produtos": null,
      "TabelaFreteId": 0,
      "Prazo": 0,
      "Valor": 0.0,
      "Ajuste": 0.0,
      "ValorCotacaoTodos": 0.0
    }
  ],
  "AjustesCarrinho": [
    {
      "Tipo": 0,
      "Valor": 0.0,
      "Nome": null
    },
    {
      "Tipo": 0,
      "Valor": 0.0,
      "Nome": null
    }
  ],
  "Usuario": {
    "Cnpj": "string",
    "Cpf": "string",
    "Email": "string",
    "Id": 0,
    "Nome": "string",
    "Telefone": "string",
    "Enderecos": [
      {
        "Bairro": "string",
        "Cep": 0,
        "Cidade": "string",
        "Complemento": "string",
        "Estado": "string",
        "Numero": "string",
        "Logradouro": "string",
        "Id": 0
      }
    ],
    "PessoaJuridica": false,
    "InscricaoEstadual": false
  },
  "EnderecoEntrega": {
    "Bairro": "string",
    "Cep": 0,
    "Cidade": "string",
    "Complemento": "string",
    "Estado": "string",
    "Numero": "string",
    "Logradouro": "string",
    "Id": 0
  },
  "Metadados": {
    "chave": "valor"
  }
}

Objeto JSON que deverá ser retornado pela sua API:

[
    {
        ProdutoVarianteId: 123,
        Valor: 10,
        Nome: "Nome do ajuste",
        CentroDistribuicaoId: 1
    },
    {
        ProdutoVarianteId: 456,
        Valor: 20,
        Nome: "Nome do ajuste",
        CentroDistribuicaoId: 1
    },
    {
        ProdutoVarianteId: 789,
        Valor: 30,
        Nome: "Nome do ajuste",
        CentroDistribuicaoId: 1
    }
]

Em casos onde tem mais de uma unidade do mesmo produto, o envio do ajuste dever ser a somatoria dos ajustes em um unico retorno.

Exemplo: O cliente irá comprar 3 unidades de uma camiseta, o aliquotas irá enviar a requisição para a API cadastra informando a quantidade do produto, a API irá calcular que cada unidade tem um ajuste de R$10,00, somando R$30,00 de ajuste, o retorno para a plataforma deverá ficar da seguinte forma:

[
    {
        ProdutoVarianteId: 123,
        Valor: 30,
        Nome: "Nome do ajuste",
        CentroDistribuicaoId: 1
    }
]

🚧
Informamos que a API da Alíquotas possui um tempo de timeout de 2 segundos.