Changelog
Back to All

Inclusão dos ajustes de um carrinho na API de Alíquotas

17 days ago by Angela Santos

Foi adicionado o array AjustesCarrinho no corpo da requisição, contendo objetos com os campos Tipo, Valor e Nome, utilizados para representar ajustes globais aplicados sobre o total do pedido (ex: cupons de desconto ou promoções por produto)

🧾 Como era antes?

Antes desta implementação, a API de Alíquotas não informava se um carrinho havia recebido um ajuste, o que resultava em cálculos que dependeriam de outras requisições ou então não totalmente preciso, ou seja:

  • Não existia o campo AjustesCarrinho no corpo da requisição da API;
  • Os parceiros não tinham visibilidade sobre o uso dessa possibilidade de ajustes no pedido;
  • Isso dificultava ações automatizadas, como por exemplo regras de cashback.

✅ O que mudou?

Agora os parceiros passam a ter visibilidade sobre os ajustes aplicados em um carrinho, o que possibilita ter mais praticidade e flexibilidade para aplicar um desconto, por exemplo.

Tipos de Ajustes que serão retornados:

  • Cupom de Desconto (tipo 6);
  • Promoção por Produto (tipo 10);
  • Promoção Frete (tipo 7);
  • Atacarejo (tipo 3).

🧪 Exemplo de payload com o array AjustesCarrinho

{
  "Id": "8597845-2315-4cc3-89fe-65359764",
  "Fechado": false,
  "Cep": 80030001,
  "Produtos": [
    {
      "PrecoDe": 100.0,
      "PrecoPor": 75.0,
      "ProdutoVarianteId": 644152,
      "Quantidade": 1,
      "CentroDistribuicaoId": 25,
      "Sku": "canetaWake"
    }
  ],
  "ValorFrete": 5.20,
  "ValorTotal": 75.00,
  "ContaCorrente": 0.0,
  "FreteEscolhido": {
    "Valor": 5.20,
    "Ajuste": 0.0,
    "Prazo": 0,
    "ValorCotacaoTodos": 0.0
  },
  "Cotacoes": [
    {
      "CotacaoFreteId": null,
      "Nome": "Teste",
      "Produtos": null,
      "TabelaFreteId": 0,
      "Prazo": 2,
      "Valor": 5.20,
      "Ajuste": 0.0,
      "ValorCotacaoTodos": 0.0
    }
  ],
  "AjustesCarrinho": [
    {
      "Tipo": 6,
      "Valor": 12.00,
      "Nome": "Promoção por Cupom de Desconto"
    },
    {
      "Tipo": 10,
      "Valor": 15.00,
      "Nome": "Promoção por Produto"
    }
  ],
  "Usuario": {
    "Cnpj": "",
    "Cpf": "18105124092",
    "Email": "[email protected]",
    "Id": 410558,
    "Nome": "Nome do comprador",
    "Telefone": "",
    "Enderecos": [
      {
        "Bairro": "Juvevê",
        "Cep": 80030001,
        "Cidade": "Curitiba",
        "Complemento": "9º Andar",
        "Estado": "PR",
        "Numero": "1698",
        "Logradouro": "Avenida João Gualberto",
        "Id": 683406
      }
    ],
    "PessoaJuridica": false,
    "InscricaoEstadual": false
  },
  "EnderecoEntrega": {
    "Bairro": "Juvevê",
    "Cep": 80030001,
    "Cidade": "Curitiba",
    "Complemento": "9º Andar",
    "Estado": "PR",
    "Numero": "1698",
    "Logradouro": "Avenida João Gualberto",
    "Id": 683406
  }
}

📘

Nota técnica

Nenhuma alteração é necessária por parte dos integradores, exceto se desejarem consumir o novo campo.

📚 Documentação

Confira como utilizar essa funcionalidade na documentação oficial da API de alíquotas.