OTL ShoesAPI
Exemplos em
Menu da documentação

Todos os endpoints

A API inteira em uma página, por recurso. Clique no nome para ver parâmetros, exemplos e erros.

URL base: https://api.otlshoes.com.brhttps://api-sandbox.otlshoes.com.br. Toda chamada leva o cabeçalho Authorization: Bearer <token>.

Conta

MétodoRotaO que fazPermissão
GET/v1/euQuem sou euqualquer token
GET/v1/contaConta do parceiroconta:ler

Produtos

MétodoRotaO que fazPermissão
GET/v1/produtosListar produtosprodutos:ler
GET/v1/produtos/{sku}Detalhar produtoprodutos:ler
GET/v1/produtos/{sku}/estoqueEstoque do produtoprodutos:ler
GET/v1/categoriasCategorias, estilos e tagsprodutos:ler
GET/v1/numeracoesNumeraçõesprodutos:ler

Clientes

MétodoRotaO que fazPermissão
GET/v1/clientesListar clientesclientes:ler
GET/v1/clientes/{id}Detalhar clienteclientes:ler
POST/v1/clientesCriar clienteclientes:escrever
PATCH/v1/clientes/{id}Alterar clienteclientes:escrever
DELETE/v1/clientes/{id}Remover clienteclientes:escrever

Pedidos

MétodoRotaO que fazPermissão
GET/v1/pedidosListar pedidospedidos:ler
GET/v1/pedidos/{id}Detalhar pedidopedidos:ler
POST/v1/pedidosCriar pedidopedidos:criar
POST/v1/pedidos/validarSimular pedidopedidos:criar
PATCH/v1/pedidos/{id}/itens/{itemId}/valor-vendaInformar valor de vendapedidos:escrever
POST/v1/pedidos/{id}/despesasLançar despesapedidos:escrever
DELETE/v1/pedidos/{id}/despesas/{despesaId}Remover despesapedidos:escrever
POST/v1/pedidos/{id}/rastreiosCadastrar rastreiopedidos:escrever
DELETE/v1/pedidos/{id}/rastreios/{rastreioId}Remover rastreiopedidos:escrever
POST/v1/pedidos/{id}/anexosEnviar comprovantepedidos:escrever
GET/v1/pedidos/{id}/anexos/{anexoId}/arquivoBaixar anexopedidos:ler
DELETE/v1/pedidos/{id}/anexos/{anexoId}Remover comprovantepedidos:escrever

Financeiro

MétodoRotaO que fazPermissão
GET/v1/financeiro/saldoSaldofinanceiro:ler
GET/v1/financeiro/extratoExtratofinanceiro:ler

Etiquetas

MétodoRotaO que fazPermissão
GET/v1/superfreteConta SuperFreteetiquetas:ler
GET/v1/pedidos/{id}/etiquetas/cotacaoCotar freteetiquetas:ler
POST/v1/pedidos/{id}/etiquetasEmitir etiquetaetiquetas:emitir
GET/v1/pedidos/{id}/etiquetasEtiquetas do pedidoetiquetas:ler
DELETE/v1/pedidos/{id}/etiquetas/{etiquetaId}Cancelar etiquetaetiquetas:emitir

Loja-hub

MétodoRotaO que fazPermissão
GET/v1/loja-hubVer a lojaloja-hub:ler
PATCH/v1/loja-hubAlterar a lojaloja-hub:escrever
POST/v1/loja-hub/publicarPublicarloja-hub:escrever
POST/v1/loja-hub/despublicarDespublicarloja-hub:escrever
GET/v1/loja-hub/selecaoVer a seleçãoloja-hub:ler
PUT/v1/loja-hub/selecaoDefinir a seleçãoloja-hub:escrever
GET/v1/loja-hub/estatisticasEstatísticasloja-hub:ler
GET/v1/loja-hub/aparenciaVer a aparêncialoja-hub:ler
PUT/v1/loja-hub/aparenciaDefinir a aparêncialoja-hub:escrever
GET/v1/loja-hub/bannersListar bannersloja-hub:ler
POST/v1/loja-hub/bannersEnviar bannerloja-hub:escrever
PATCH/v1/loja-hub/banners/{bannerId}Alterar bannerloja-hub:escrever
PUT/v1/loja-hub/banners/ordemOrdenar bannersloja-hub:escrever
DELETE/v1/loja-hub/banners/{bannerId}Remover bannerloja-hub:escrever
POST/v1/loja-hub/logoEnviar logoloja-hub:escrever
DELETE/v1/loja-hub/logoRemover logoloja-hub:escrever
GET/v1/loja-hub/seo/produtos/{sku}Ver texto do produtoloja-hub:ler
PUT/v1/loja-hub/seo/produtos/{sku}Gravar texto do produtoloja-hub:escrever
DELETE/v1/loja-hub/seo/produtos/{sku}Remover texto do produtoloja-hub:escrever

Simuladores (sandbox)

MétodoRotaO que fazPermissão
POST/v1/sandbox/pedidos/{id}/statusSimular status do pedidoqualquer token de teste
POST/v1/sandbox/pedidos/{id}/anexos/{anexoId}/validarSimular validação do comprovantequalquer token de teste
POST/v1/sandbox/pedidos/{id}/rastreios/{rastreioId}/validarSimular validação do rastreioqualquer token de teste
POST/v1/sandbox/etiquetas/{id}/statusSimular status da etiquetaqualquer token de teste
POST/v1/sandbox/financeiro/lancamentosSimular lançamento no saldoqualquer token de teste
PUT/v1/sandbox/produtos/{sku}/estoqueSimular estoquequalquer token de teste
POST/v1/sandbox/conta/resetarResetar a conta de testequalquer token de teste

Cores dos métodos

GET lê, sem alterar nada. POST cria.PATCH altera parte de um recurso. PUT substitui um recurso inteiro. DELETE remove.