Storefront Alfa API

50 endpoints organizados em 6 módulos

Documentação Interativa

✨ScalarRecomendado

Interface moderna e elegante

Interface clássica do Swagger

Integrações Disponíveis

Use o header loja com um dos aliases abaixo:

superepi (Linx Commerce)uniexbresser (Uappi)secure (Nuvemshop)

Endpoints por Módulo

Carrinho

12 métodos

POST /carrinho
GET /carrinho/{id}
DELETE /carrinho/{id}/itens
POST /carrinho/{id}/itens
PATCH /carrinho/{id}/itens/{itemId}
DELETE /carrinho/{id}/itens/{itemId}
POST /carrinho/{id}/cupom
DELETE /carrinho/{id}/cupom
POST /carrinho/{id}/frete
PATCH /carrinho/{id}/entrega
POST /carrinho/{id}/finalizar
POST /carrinho/{id}/checkout

Usuário

6 métodos

POST /usuario/login
POST /usuario/cadastro
GET /usuario/sessao
DELETE /usuario/sessao
POST /usuario/recuperar-senha
POST /usuario/resetar-senha

Listagem

4 métodos

GET /listagem/vitrine
GET /listagem/categoria/{slug}
GET /listagem/marca/{slug}
GET /listagem/busca

Produto

5 métodos

GET /produto/{identificador}
GET /produto/{id}/avaliacoes
POST /produto/{id}/frete
GET /produto/{id}/pagamento
GET /produto/{id}/associacoes

Painel do Cliente

9 métodos

PATCH /cliente/dados
GET /cliente/enderecos
GET /cliente/enderecos/{id}
PATCH /cliente/enderecos/{id}
DELETE /cliente/enderecos/{id}
GET /cliente/pedidos
GET /cliente/pedidos/{id}
DELETE /cliente/pedidos/{id}
GET /cliente/vales

Checkout

14 métodos

GET /checkout/{carrinhoId}
POST /checkout/{carrinhoId}/login
POST /checkout/{carrinhoId}/cadastro
GET /checkout/{carrinhoId}/enderecos
POST /checkout/{carrinhoId}/enderecos
PATCH /checkout/{carrinhoId}/enderecos/{enderecoId}
DELETE /checkout/{carrinhoId}/enderecos/{enderecoId}
POST /checkout/{carrinhoId}/frete
GET /checkout/{carrinhoId}/entregas
PATCH /checkout/{carrinhoId}/entregas/{entregaId}
GET /checkout/{carrinhoId}/pagamentos
POST /checkout/{carrinhoId}/pagamentos
PATCH /checkout/{carrinhoId}/pagamentos/{pagamentoId}
POST /checkout/{carrinhoId}/finalizar