Cancelamento de Pedido Autorizado

OverviewCopied!

O módulo de cancelamento de pedido autorizado permite que o fornecedor gerencie o cancelamento de pedidos que ainda não tiveram nenhuma nota fiscal enviada no sistema Tino. Este módulo é essencial para liberar a reserva de limite do lojista quando um pedido precisa ser cancelado antes de sua confirmação por parte do Fornecedor. É fundamental que o fornecedor realize o cancelamento sempre que não for mais faturar um pedido, pois somente assim o lojista terá seu limite liberado para efetuar novas compras.

Canais de CancelamentoCopied!

O Tino oferece quatro canais para processamento de cancelamentos de pedidos pré-autorizados, alinhados com o tipo de integração que você possui:

  1. Cancelamento via VTEX

  2. Cancelamento via E-commerce Próprio

Cenários de IntegraçãoCopied!

1. Integração via VTEXCopied!

Para fornecedores que utilizam a plataforma VTEX, o processo de cancelamento é gerenciado através do plugin VTEX do Tino. O plugin inclui as funcionalidades necessárias para:

  • Cancelamento automático de pedidos pré-autorizados

  • Liberação da reserva de limite

  • Atualização do status do pedido

  • Notificação ao lojista

Endpoints Relevantes:

  • O plugin VTEX gerencia automaticamente as chamadas necessárias

  • Verifique a configuração correta dos fluxos de cancelamento na sua plataforma VTEX

2. Integração para E-commerce PróprioCopied!

Para fornecedores com e-commerce próprio, o cancelamento de pedidos pré-autorizados é realizado através da API do Tino, com dois fluxos principais:

Fluxo de Cancelamento Online

  • Integrado ao SDK do Tino

  • Cancela automaticamente a reserva de limite

Fluxo de Cancelamento Assistido

  • Recomendado para cancelamentos que necessitam de intervenção do fornecedor

  • Processo gerenciado via API

Endpoints Principais:

Cancelar Reserva de Limite

  • DELETE /v2/limit-reservations/{id} - Cancelamento da reserva de limite

    • Path Parameters:

      • id (required): Identificador (UUID) da Reserva de Limite

    • Headers:

      • X-API-KEY (required): Chave de acesso

    • Responses:

      • 204: Cancelamento bem sucedido

      • 400: Requisição inválida

      • 401: API Key inválida ou ausente

      • 422: Reserva de Limite não cancelável (já faturada ou já cancelada)

      • 500: Erro inesperado

    curl <https://supplier-api.truepay.app/v2/limit-reservations/{id}> \\
      --request DELETE \\
      --header 'Content-Type: application/json' \\
      --header 'X-Api-Key: YOUR_SECRET_TOKEN'

Consulta de Reservas

  • GET /v2/limit-reservations/{external_id} - Consulta as reservas de limite de um pedido

    • Path Parameters:

      • external_id (required): Identificador do pedido

    • Headers:

      • X-API-KEY (required): Chave de acesso

    • Responses:

      • 200: Lista de reservas de limite

      • 400: Requisição inválida

      • 401: API Key inválida ou ausente

      • 500: Erro inesperado

    • Exemplo de Resposta (200):

    [
      {
        "amount_cents": 1014,
        "cashout_frequency": [
          30,
          60,
          90
        ],
        "created_at": "2024-05-24T15:47:33.014626Z",
        "external_id": "123",
        "id": "50406bb6-d306-4a3a-a795-6dad0cd31a81",
        "merchant_document_number": "06331795000105",
        "status": "pending"
      }
    ]

Etapas do CancelamentoCopied!

  1. Processamento do Cancelamento

    • Verificação do status da reserva de limite

    • Confirmação que a reserva não foi faturada

    • Liberação do limite reservado para o cliente

  2. Conclusão do Cancelamento

    • Atualização do status da reserva para cancelada

    • Registro do cancelamento no histórico do pedido

    • Notificação ao lojista sobre a liberação do limite