Saltar para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://pedirgasdocs.supergasbras.app/llms.txt

Use this file to discover all available pages before exploring further.

Este guia mostra como fazer sua primeira integração completa com as APIs Supergasbras. Você vai criar uma sessão de carrinho, iniciar o checkout e consultar os métodos de pagamento disponíveis.

Pré-requisitos

  • Um token de acesso válido — veja Autenticação
  • Uma ferramenta para fazer requisições HTTP (cURL, Postman, ou o cliente de sua preferência)

Passo 1: Criar ou atualizar o carrinho

Use a Cart API para criar uma sessão de carrinho. Substitua SESSION_ID por um identificador único para a sessão do cliente.
curl -X PUT "https://cart-ms.supergasbras.app/v1/sessions/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "c9b1d2e3-f4a5-6789-bcde-f01234567890"
  }'
A API retorna os dados da sessão de carrinho criada ou atualizada.

Passo 2: Consultar o carrinho

Confirme que o carrinho foi criado corretamente:
curl -X GET "https://cart-ms.supergasbras.app/v1/sessions/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI"

Passo 3: Criar a sessão de checkout

Com o carrinho pronto, inicie o checkout na Checkout API:
curl -X POST "https://checkout-ms.supergasbras.app/v1/sessions" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "cartSessionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "customerId": "c9b1d2e3-f4a5-6789-bcde-f01234567890"
  }'
Guarde o sessionId retornado — você vai usá-lo nos próximos passos.

Passo 4: Atualizar informações de entrega

curl -X PUT "https://checkout-ms.supergasbras.app/v1/sessions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delivery" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "address": {
      "street": "Rua Exemplo",
      "number": "123",
      "city": "São Paulo",
      "state": "SP",
      "zipCode": "01310-100"
    }
  }'

Passo 5: Consultar métodos de pagamento

Liste os métodos de pagamento disponíveis para a sessão:
curl -X GET "https://checkout-ms.supergasbras.app/v1/sessions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/payments/methods" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI"

Próximos passos

Criar um pedido completo

Guia detalhado do fluxo completo de compra, do carrinho ao pagamento.

Aplicar cupons

Saiba como listar, reservar e aplicar cupons promocionais.

Processar pagamentos

Detalhes sobre os métodos de pagamento e como iniciar uma cobrança.

API Reference

Referência completa de todos os endpoints disponíveis.