Glossário (OCA)

🧩 Termos Utilizados

TermoDescrição
CheckoutEtapa final da jornada de compra, onde o cliente confirma endereço, método de entrega e pagamento, e finaliza o pedido.
OCAOpen Checkout API. API responsável pelo fluxo de checkout, comunicação entre carrinho, endereço, entrega e pagamentos.
SessionIDIdentificador único da sessão do usuário no checkout, utilizado em todas as chamadas da API.
BasketIDIdentificador do carrinho associado à sessão do usuário.
BasketAuthorityTokenToken de autorização do carrinho, usado para validar o acesso às operações de checkout.
GroupKeyChave identificadora de grupo de itens dentro do carrinho (ex.: em casos de multientrega ou multiloja).
DeliveryOptionIDIdentificador da opção de entrega escolhida, retornada após o cálculo de frete.
AddressID (ID)Identificador de um endereço cadastrado pelo cliente. Pode ser usado tanto para entrega quanto cobrança.
PaymentGroupsConjunto de meios de pagamento disponíveis, agrupados conforme a configuração da loja.
PaymentMethodIDIdentificador interno de um meio de pagamento (ex.: cartão de crédito, boleto, Pix, etc.).
CardInfoObjeto que contém as informações do cartão de crédito (nome, número, CVV, validade), ou token equivalente, conforme a integração.
InstallmentsNúmero de parcelas selecionadas pelo cliente no momento do pagamento.
PlaceOrderAção que efetiva o pedido, enviando as informações consolidadas de entrega e pagamento.
AddCoupon / RemoveCouponMétodos utilizados para aplicar ou remover cupons de desconto no checkout.
OMS (Order Management System)Sistema de gerenciamento de pedidos, utilizado para identificar lojas, pontos de retirada e endereços de entrega.
GetOMSLocationsEndpoint responsável por listar locais de retirada disponíveis para determinada opção de entrega.
GetOMSLocationsWithDistanceVersão do método anterior que inclui cálculo de distância com base em latitude e longitude.
Provider de PagamentoSistema externo responsável por processar pagamentos (ex.: Pagar.me, AppMax, MercadoPago).
Extensibilidade de Pagamento (OPA)API complementar que permite integrar provedores de pagamento externos de forma modular e independente.
Extensibilidade de Entrega (OLA)API complementar utilizada para integrações de frete, cotações e transportadoras externas.
CupomCódigo promocional que concede desconto ou benefício aplicado durante o checkout.
Place Order ResponseRetorno do endpoint de fechamento do pedido, contendo ID do pedido, status de pagamento e dados da transação.
Erro de ComunicaçãoFalhas entre OCA e provedores externos (pagamento, OMS, etc.) devem ser tratadas com contingência local.

⚙️ Conceitos Complementares

ConceitoDescrição
Fluxo SíncronoAs requisições da OCA são processadas de forma síncrona — o retorno ocorre apenas após o processamento da operação (ex.: cálculo de frete, aplicação de cupom).
ExtensibilidadeA arquitetura da OCA é baseada em APIs abertas (Open APIs), permitindo integrar provedores e serviços externos sem dependência de release interno.
Tokenização de CartãoEm meios de pagamento que utilizam tokenização, o front envia um token em vez dos dados sensíveis do cartão.
Contingência LocalConfiguração interna utilizada quando há falha na comunicação com o provedor, garantindo que o checkout continue funcional.
Multi-EntregaCapacidade da OCA de gerenciar múltiplos endereços de entrega dentro de um mesmo pedido.
Split de PagamentoDistribuição do valor da venda entre múltiplos recebedores, quando suportado pelo provedor.
  • Sem rótulos