Pular para o conteúdo principal
A Checkout API controla o fluxo completo de finalização de uma compra na plataforma Supergasbras. Ela gerencia sessões de compra, dados de entrega, cupons promocionais e pagamentos.

O que é uma sessão de compra

Uma sessão de compra (checkout session) é criada quando o cliente decide finalizar os itens do carrinho. Ela concentra todas as informações necessárias para concluir um pedido:
  • Dados do cliente
  • Endereço e informações de entrega
  • Cupons promocionais aplicados
  • Método e status de pagamento

Fluxo de checkout

1

Criar a sessão

Chame POST /v1/sessions com o cartSessionId e o customerId para iniciar o checkout.
2

Atualizar a entrega

Use PUT /v1/sessions/{sessionId}/delivery para definir o endereço de entrega.
3

Aplicar cupons (opcional)

Use PUT /v1/sessions/{sessionId}/coupons para aplicar um código promocional.
4

Selecionar pagamento

Liste os métodos disponíveis com GET /v1/sessions/{sessionId}/payments/methods e inicie o pagamento com POST /v1/sessions/{sessionId}/payments.
5

Completar o pedido

Finalize com POST /v1/sessions/{sessionId}/complete para confirmar o pedido.

Endpoints da Checkout API

Cancelar uma sessão

Se necessário, você pode cancelar uma sessão de compra antes de concluí-la:
Sessões já concluídas (COMPLETED) não podem ser canceladas. Verifique o estado da sessão antes de tentar cancelar.