{ "info": { "name": "API OTL Shoes (v1)", "description": "API pública da OTL Shoes para parceiros do programa de dropshipping.\n\nDocumentação: https://docs.otlshoes.com.br\n\nImporte também um dos ambientes (Produção ou Sandbox) e preencha a variável `token` com o token da sua integração.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "https://api.otlshoes.com.br/v1" }, { "key": "token", "value": "" } ], "item": [ { "name": "Conta", "item": [ { "name": "Quem sou eu", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/eu", "host": [ "{{baseUrl}}" ], "path": [ "eu" ] }, "description": "Confirma que o token funciona e mostra o que ele pode fazer. É a primeira chamada de toda integração.\n\n**Permissão:** qualquer token válido\n\n[Documentação](https://docs.otlshoes.com.br/referencia/conta/eu)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/eu", "host": [ "{{baseUrl}}" ], "path": [ "eu" ] }, "description": "Confirma que o token funciona e mostra o que ele pode fazer. É a primeira chamada de toda integração.\n\n**Permissão:** qualquer token válido\n\n[Documentação](https://docs.otlshoes.com.br/referencia/conta/eu)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"parceiro\": {\n \"nome\": \"Loja do João\",\n \"loja\": \"João Calçados\"\n },\n \"integracao\": {\n \"id\": \"cmuq5txm9000510arvq62c497\",\n \"nome\": \"Bling – João Dev\",\n \"criadaEm\": \"2026-10-01T20:23:15-03:00\",\n \"expiraEm\": \"2026-10-31T20:23:15-03:00\"\n },\n \"permissoes\": [\n \"conta:ler\",\n \"produtos:ler\"\n ],\n \"limite\": {\n \"porMinuto\": 60,\n \"restante\": 59\n },\n \"ambiente\": \"producao\"\n}" } ] }, { "name": "Conta do parceiro", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/conta", "host": [ "{{baseUrl}}" ], "path": [ "conta" ] }, "description": "Dados da loja do parceiro e o endereço de remetente. Somente leitura.\n\n**Permissão:** `conta:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/conta/dados)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/conta", "host": [ "{{baseUrl}}" ], "path": [ "conta" ] }, "description": "Dados da loja do parceiro e o endereço de remetente. Somente leitura.\n\n**Permissão:** `conta:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/conta/dados)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"nome\": \"Loja do João\",\n \"loja\": {\n \"nome\": \"João Calçados\",\n \"telefone\": \"5551988887777\",\n \"site\": \"https://joaocalcados.com.br\"\n },\n \"remetente\": {\n \"nome\": \"João Calçados\",\n \"cep\": \"91000-000\",\n \"rua\": \"Av. Brasil\",\n \"numero\": \"500\",\n \"complemento\": \"Sala 2\",\n \"bairro\": \"Centro\",\n \"cidade\": \"Canoas\",\n \"uf\": \"RS\",\n \"origem\": \"loja\"\n },\n \"links\": [\n {\n \"plataforma\": \"SHOPEE\",\n \"rotulo\": null,\n \"url\": \"https://shopee.com.br/joaocalcados\"\n },\n {\n \"plataforma\": \"OUTRO\",\n \"rotulo\": \"Enjoei\",\n \"url\": \"https://enjoei.com.br/joaocalcados\"\n }\n ],\n \"fichaCompleta\": true\n}" } ] } ] }, { "name": "Produtos", "item": [ { "name": "Listar produtos", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/produtos?limite=50", "host": [ "{{baseUrl}}" ], "path": [ "produtos" ], "query": [ { "key": "limite", "value": "50", "description": "Itens por página, de 1 a 100.", "disabled": false }, { "key": "cursor", "value": "", "description": "O proximoCursor da resposta anterior.", "disabled": true }, { "key": "atualizadoDesde", "value": "2026-09-29T14:00:00-03:00", "description": "Só o que mudou a partir desta data (com fuso). Inclui desativados.", "disabled": true }, { "key": "busca", "value": "adidas", "description": "Só dígitos procura no SKU; texto, no título.", "disabled": true }, { "key": "categoria", "value": "", "description": "Id de uma categoria (GET /categorias).", "disabled": true }, { "key": "estilo", "value": "", "description": "Id de um estilo.", "disabled": true }, { "key": "tag", "value": "", "description": "Id de uma tag.", "disabled": true }, { "key": "numeracao", "value": "38", "description": "Só produtos com estoque nesta numeração.", "disabled": true }, { "key": "comEstoque", "value": "true", "description": "true: com estoque em alguma numeração.", "disabled": true }, { "key": "ordem", "value": "recentes", "description": "recentes, atualizacao, preco_asc, preco_desc ou titulo.", "disabled": true } ] }, "description": "O catálogo, com preço de atacado, preço da loja do parceiro, foto e estoque por numeração. Paginado por cursor.\n\n**Permissão:** `produtos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/produtos/listar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/produtos?limite=50", "host": [ "{{baseUrl}}" ], "path": [ "produtos" ], "query": [ { "key": "limite", "value": "50", "description": "Itens por página, de 1 a 100.", "disabled": false }, { "key": "cursor", "value": "", "description": "O proximoCursor da resposta anterior.", "disabled": true }, { "key": "atualizadoDesde", "value": "2026-09-29T14:00:00-03:00", "description": "Só o que mudou a partir desta data (com fuso). Inclui desativados.", "disabled": true }, { "key": "busca", "value": "adidas", "description": "Só dígitos procura no SKU; texto, no título.", "disabled": true }, { "key": "categoria", "value": "", "description": "Id de uma categoria (GET /categorias).", "disabled": true }, { "key": "estilo", "value": "", "description": "Id de um estilo.", "disabled": true }, { "key": "tag", "value": "", "description": "Id de uma tag.", "disabled": true }, { "key": "numeracao", "value": "38", "description": "Só produtos com estoque nesta numeração.", "disabled": true }, { "key": "comEstoque", "value": "true", "description": "true: com estoque em alguma numeração.", "disabled": true }, { "key": "ordem", "value": "recentes", "description": "recentes, atualizacao, preco_asc, preco_desc ou titulo.", "disabled": true } ] }, "description": "O catálogo, com preço de atacado, preço da loja do parceiro, foto e estoque por numeração. Paginado por cursor.\n\n**Permissão:** `produtos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/produtos/listar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"dados\": [\n {\n \"sku\": \"320\",\n \"titulo\": \"Tênis Adidas Forum Low Branco\",\n \"imagem\": \"https://cdn.otlshoes.com.br/otl-catalog/drop/320.webp\",\n \"precoAtacado\": \"139.90\",\n \"precoSugerido\": \"259.90\",\n \"precoAtual\": \"209.90\",\n \"numeracoes\": [\n {\n \"numeracao\": \"38\",\n \"skuVariacao\": \"320U\",\n \"estoque\": 4\n },\n {\n \"numeracao\": \"39\",\n \"skuVariacao\": \"320V\",\n \"estoque\": 0\n },\n {\n \"numeracao\": \"40\",\n \"skuVariacao\": \"320W\",\n \"estoque\": 7\n }\n ],\n \"categorias\": [\n {\n \"id\": \"cmf1a2b3c0001\",\n \"nome\": \"Casual\"\n }\n ],\n \"estilos\": [\n {\n \"id\": \"cmf1a2b3c0002\",\n \"nome\": \"Masculino\"\n }\n ],\n \"tags\": [\n {\n \"id\": \"cmf1a2b3c0003\",\n \"nome\": \"Lançamento\"\n }\n ],\n \"ativo\": true,\n \"atualizadoEm\": \"2026-09-29T10:12:00-03:00\"\n },\n {\n \"sku\": \"631\",\n \"titulo\": \"Tênis Meia LED Homem Aranha\",\n \"imagem\": \"https://cdn.otlshoes.com.br/otl-catalog/drop/631.webp\",\n \"precoAtacado\": \"89.90\",\n \"precoSugerido\": \"169.90\",\n \"precoAtual\": \"139.90\",\n \"numeracoes\": [\n {\n \"numeracao\": \"27/28\",\n \"skuVariacao\": \"631J\",\n \"estoque\": 3\n },\n {\n \"numeracao\": \"29/30\",\n \"skuVariacao\": \"631L\",\n \"estoque\": null\n }\n ],\n \"categorias\": [\n {\n \"id\": \"cmf1a2b3c0009\",\n \"nome\": \"Infantil\"\n }\n ],\n \"estilos\": [],\n \"tags\": [],\n \"ativo\": true,\n \"atualizadoEm\": \"2026-09-28T16:40:00-03:00\"\n }\n ],\n \"paginacao\": {\n \"proximoCursor\": \"eyJvIjoicmVjZW50ZXMiLCJ2IjoiMjAyNi0wOS0yOFQxOTo0MDowMC4wMDBaIiwiaWQiOiJjbWYxIn0\",\n \"temMais\": true\n }\n}" } ] }, { "name": "Detalhar produto", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/produtos/:sku", "host": [ "{{baseUrl}}" ], "path": [ "produtos", ":sku" ], "variable": [ { "key": "sku", "value": "320", "description": "O SKU do produto." } ] }, "description": "Um produto pelo SKU. Produto desativado também responde, com ativo: false.\n\n**Permissão:** `produtos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/produtos/detalhar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/produtos/:sku", "host": [ "{{baseUrl}}" ], "path": [ "produtos", ":sku" ], "variable": [ { "key": "sku", "value": "320", "description": "O SKU do produto." } ] }, "description": "Um produto pelo SKU. Produto desativado também responde, com ativo: false.\n\n**Permissão:** `produtos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/produtos/detalhar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"sku\": \"320\",\n \"titulo\": \"Tênis Adidas Forum Low Branco\",\n \"imagem\": \"https://cdn.otlshoes.com.br/otl-catalog/drop/320.webp\",\n \"precoAtacado\": \"139.90\",\n \"precoSugerido\": \"259.90\",\n \"precoAtual\": \"209.90\",\n \"numeracoes\": [\n {\n \"numeracao\": \"38\",\n \"skuVariacao\": \"320U\",\n \"estoque\": 4\n },\n {\n \"numeracao\": \"39\",\n \"skuVariacao\": \"320V\",\n \"estoque\": 0\n },\n {\n \"numeracao\": \"40\",\n \"skuVariacao\": \"320W\",\n \"estoque\": 7\n }\n ],\n \"categorias\": [\n {\n \"id\": \"cmf1a2b3c0001\",\n \"nome\": \"Casual\"\n }\n ],\n \"estilos\": [\n {\n \"id\": \"cmf1a2b3c0002\",\n \"nome\": \"Masculino\"\n }\n ],\n \"tags\": [\n {\n \"id\": \"cmf1a2b3c0003\",\n \"nome\": \"Lançamento\"\n }\n ],\n \"ativo\": true,\n \"atualizadoEm\": \"2026-09-29T10:12:00-03:00\"\n}" } ] }, { "name": "Estoque do produto", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/produtos/:sku/estoque", "host": [ "{{baseUrl}}" ], "path": [ "produtos", ":sku", "estoque" ], "variable": [ { "key": "sku", "value": "320", "description": "O SKU do produto." } ] }, "description": "Só o estoque por numeração. Leve — para confirmar na hora da venda, não para varrer o catálogo.\n\n**Permissão:** `produtos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/produtos/estoque)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/produtos/:sku/estoque", "host": [ "{{baseUrl}}" ], "path": [ "produtos", ":sku", "estoque" ], "variable": [ { "key": "sku", "value": "320", "description": "O SKU do produto." } ] }, "description": "Só o estoque por numeração. Leve — para confirmar na hora da venda, não para varrer o catálogo.\n\n**Permissão:** `produtos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/produtos/estoque)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"sku\": \"320\",\n \"ativo\": true,\n \"numeracoes\": [\n {\n \"numeracao\": \"38\",\n \"skuVariacao\": \"320U\",\n \"estoque\": 4\n },\n {\n \"numeracao\": \"39\",\n \"skuVariacao\": \"320V\",\n \"estoque\": 0\n },\n {\n \"numeracao\": \"40\",\n \"skuVariacao\": \"320W\",\n \"estoque\": 7\n }\n ],\n \"atualizadoEm\": \"2026-09-29T10:12:00-03:00\"\n}" } ] }, { "name": "Categorias, estilos e tags", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categorias", "host": [ "{{baseUrl}}" ], "path": [ "categorias" ] }, "description": "Os identificadores aceitos nos filtros de produtos.\n\n**Permissão:** `produtos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/produtos/categorias)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categorias", "host": [ "{{baseUrl}}" ], "path": [ "categorias" ] }, "description": "Os identificadores aceitos nos filtros de produtos.\n\n**Permissão:** `produtos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/produtos/categorias)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"categorias\": [\n {\n \"id\": \"cmf1a2b3c0001\",\n \"nome\": \"Casual\"\n },\n {\n \"id\": \"cmf1a2b3c0009\",\n \"nome\": \"Infantil\"\n }\n ],\n \"estilos\": [\n {\n \"id\": \"cmf1a2b3c0002\",\n \"nome\": \"Masculino\"\n }\n ],\n \"tags\": [\n {\n \"id\": \"cmf1a2b3c0003\",\n \"nome\": \"Lançamento\"\n }\n ]\n}" } ] }, { "name": "Numerações", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/numeracoes", "host": [ "{{baseUrl}}" ], "path": [ "numeracoes" ] }, "description": "A tabela numeração → sufixo do SKU de variação.\n\n**Permissão:** `produtos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/produtos/numeracoes)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/numeracoes", "host": [ "{{baseUrl}}" ], "path": [ "numeracoes" ] }, "description": "A tabela numeração → sufixo do SKU de variação.\n\n**Permissão:** `produtos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/produtos/numeracoes)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"dados\": [\n {\n \"numeracao\": \"17\",\n \"sufixoSku\": \"AA\"\n },\n {\n \"numeracao\": \"18\",\n \"sufixoSku\": \"A\"\n },\n {\n \"numeracao\": \"19\",\n \"sufixoSku\": \"B\"\n },\n {\n \"numeracao\": \"20\",\n \"sufixoSku\": \"C\"\n },\n {\n \"numeracao\": \"21\",\n \"sufixoSku\": \"D\"\n },\n {\n \"numeracao\": \"22\",\n \"sufixoSku\": \"E\"\n },\n {\n \"numeracao\": \"23\",\n \"sufixoSku\": \"F\"\n },\n {\n \"numeracao\": \"24\",\n \"sufixoSku\": \"G\"\n },\n {\n \"numeracao\": \"25\",\n \"sufixoSku\": \"H\"\n },\n {\n \"numeracao\": \"26\",\n \"sufixoSku\": \"I\"\n },\n {\n \"numeracao\": \"27\",\n \"sufixoSku\": \"J\"\n },\n {\n \"numeracao\": \"28\",\n \"sufixoSku\": \"K\"\n },\n {\n \"numeracao\": \"29\",\n \"sufixoSku\": \"L\"\n },\n {\n \"numeracao\": \"30\",\n \"sufixoSku\": \"M\"\n },\n {\n \"numeracao\": \"31\",\n \"sufixoSku\": \"N\"\n },\n {\n \"numeracao\": \"32\",\n \"sufixoSku\": \"O\"\n },\n {\n \"numeracao\": \"33\",\n \"sufixoSku\": \"P\"\n },\n {\n \"numeracao\": \"34\",\n \"sufixoSku\": \"Q\"\n },\n {\n \"numeracao\": \"35\",\n \"sufixoSku\": \"R\"\n },\n {\n \"numeracao\": \"36\",\n \"sufixoSku\": \"S\"\n },\n {\n \"numeracao\": \"37\",\n \"sufixoSku\": \"T\"\n },\n {\n \"numeracao\": \"38\",\n \"sufixoSku\": \"U\"\n },\n {\n \"numeracao\": \"39\",\n \"sufixoSku\": \"V\"\n },\n {\n \"numeracao\": \"40\",\n \"sufixoSku\": \"W\"\n },\n {\n \"numeracao\": \"41\",\n \"sufixoSku\": \"X\"\n },\n {\n \"numeracao\": \"42\",\n \"sufixoSku\": \"Y\"\n },\n {\n \"numeracao\": \"43\",\n \"sufixoSku\": \"Z\"\n },\n {\n \"numeracao\": \"44\",\n \"sufixoSku\": \"AB\"\n },\n {\n \"numeracao\": \"45\",\n \"sufixoSku\": \"AC\"\n },\n {\n \"numeracao\": \"46\",\n \"sufixoSku\": \"AD\"\n },\n {\n \"numeracao\": \"47\",\n \"sufixoSku\": \"AE\"\n },\n {\n \"numeracao\": \"48\",\n \"sufixoSku\": \"AF\"\n }\n ]\n}" } ] } ] }, { "name": "Clientes", "item": [ { "name": "Listar clientes", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/clientes?limite=50", "host": [ "{{baseUrl}}" ], "path": [ "clientes" ], "query": [ { "key": "limite", "value": "50", "description": "Itens por página, de 1 a 100.", "disabled": false }, { "key": "cursor", "value": "", "description": "O proximoCursor da resposta anterior.", "disabled": true }, { "key": "busca", "value": "maria", "description": "Procura no nome, na cidade ou no WhatsApp.", "disabled": true }, { "key": "atualizadoDesde", "value": "2026-09-29T14:00:00-03:00", "description": "Só o que mudou a partir desta data.", "disabled": true } ] }, "description": "A agenda de clientes finais do parceiro. Paginada por cursor.\n\n**Permissão:** `clientes:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/clientes/listar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/clientes?limite=50", "host": [ "{{baseUrl}}" ], "path": [ "clientes" ], "query": [ { "key": "limite", "value": "50", "description": "Itens por página, de 1 a 100.", "disabled": false }, { "key": "cursor", "value": "", "description": "O proximoCursor da resposta anterior.", "disabled": true }, { "key": "busca", "value": "maria", "description": "Procura no nome, na cidade ou no WhatsApp.", "disabled": true }, { "key": "atualizadoDesde", "value": "2026-09-29T14:00:00-03:00", "description": "Só o que mudou a partir desta data.", "disabled": true } ] }, "description": "A agenda de clientes finais do parceiro. Paginada por cursor.\n\n**Permissão:** `clientes:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/clientes/listar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"dados\": [\n {\n \"id\": \"cmg7h2k9x0003\",\n \"nome\": \"Maria da Silva\",\n \"whatsapp\": \"5551999990000\",\n \"endereco\": {\n \"cep\": \"90000000\",\n \"rua\": \"Rua das Flores\",\n \"numero\": \"10\",\n \"complemento\": \"ap 2\",\n \"bairro\": \"Centro\",\n \"cidade\": \"Porto Alegre\",\n \"uf\": \"RS\"\n },\n \"criadoEm\": \"2026-09-20T09:15:00-03:00\",\n \"atualizadoEm\": \"2026-09-29T14:03:00-03:00\"\n },\n {\n \"id\": \"cmg7h2k9x0007\",\n \"nome\": \"Pedro Alves\",\n \"whatsapp\": null,\n \"endereco\": {\n \"cep\": \"90000000\",\n \"rua\": \"Av. Brasil\",\n \"numero\": \"500\",\n \"complemento\": null,\n \"bairro\": \"Centro\",\n \"cidade\": \"Canoas\",\n \"uf\": \"RS\"\n },\n \"criadoEm\": \"2026-09-20T09:15:00-03:00\",\n \"atualizadoEm\": \"2026-09-29T14:03:00-03:00\"\n }\n ],\n \"paginacao\": {\n \"proximoCursor\": null,\n \"temMais\": false\n }\n}" } ] }, { "name": "Detalhar cliente", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/clientes/:id", "host": [ "{{baseUrl}}" ], "path": [ "clientes", ":id" ], "variable": [ { "key": "id", "value": "cmg7h2k9x0003", "description": "O identificador do cliente." } ] }, "description": "Um cliente da agenda. Cliente de outro parceiro responde 404.\n\n**Permissão:** `clientes:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/clientes/detalhar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/clientes/:id", "host": [ "{{baseUrl}}" ], "path": [ "clientes", ":id" ], "variable": [ { "key": "id", "value": "cmg7h2k9x0003", "description": "O identificador do cliente." } ] }, "description": "Um cliente da agenda. Cliente de outro parceiro responde 404.\n\n**Permissão:** `clientes:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/clientes/detalhar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg7h2k9x0003\",\n \"nome\": \"Maria da Silva\",\n \"whatsapp\": \"5551999990000\",\n \"endereco\": {\n \"cep\": \"90000000\",\n \"rua\": \"Rua das Flores\",\n \"numero\": \"10\",\n \"complemento\": \"ap 2\",\n \"bairro\": \"Centro\",\n \"cidade\": \"Porto Alegre\",\n \"uf\": \"RS\"\n },\n \"criadoEm\": \"2026-09-20T09:15:00-03:00\",\n \"atualizadoEm\": \"2026-09-29T14:03:00-03:00\"\n}" } ] }, { "name": "Criar cliente", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"nome\": \"Maria da Silva\",\n \"whatsapp\": \"5551999990000\",\n \"endereco\": {\n \"cep\": \"90000-000\",\n \"rua\": \"Rua das Flores\",\n \"numero\": \"10\",\n \"complemento\": \"ap 2\",\n \"bairro\": \"Centro\",\n \"cidade\": \"Porto Alegre\",\n \"uf\": \"RS\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/clientes", "host": [ "{{baseUrl}}" ], "path": [ "clientes" ] }, "description": "Cadastra um cliente na agenda do parceiro. Aceita Idempotency-Key.\n\n**Permissão:** `clientes:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/clientes/criar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"nome\": \"Maria da Silva\",\n \"whatsapp\": \"5551999990000\",\n \"endereco\": {\n \"cep\": \"90000-000\",\n \"rua\": \"Rua das Flores\",\n \"numero\": \"10\",\n \"complemento\": \"ap 2\",\n \"bairro\": \"Centro\",\n \"cidade\": \"Porto Alegre\",\n \"uf\": \"RS\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/clientes", "host": [ "{{baseUrl}}" ], "path": [ "clientes" ] }, "description": "Cadastra um cliente na agenda do parceiro. Aceita Idempotency-Key.\n\n**Permissão:** `clientes:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/clientes/criar)" }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg7h2k9x0003\",\n \"nome\": \"Maria da Silva\",\n \"whatsapp\": \"5551999990000\",\n \"endereco\": {\n \"cep\": \"90000000\",\n \"rua\": \"Rua das Flores\",\n \"numero\": \"10\",\n \"complemento\": \"ap 2\",\n \"bairro\": \"Centro\",\n \"cidade\": \"Porto Alegre\",\n \"uf\": \"RS\"\n },\n \"criadoEm\": \"2026-09-20T09:15:00-03:00\",\n \"atualizadoEm\": \"2026-09-29T14:03:00-03:00\"\n}" } ] }, { "name": "Alterar cliente", "request": { "method": "PATCH", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"endereco\": {\n \"numero\": \"250\",\n \"complemento\": null\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/clientes/:id", "host": [ "{{baseUrl}}" ], "path": [ "clientes", ":id" ], "variable": [ { "key": "id", "value": "cmg7h2k9x0003", "description": "O identificador do cliente." } ] }, "description": "Altera só os campos enviados — inclusive dentro de endereco.\n\n**Permissão:** `clientes:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/clientes/alterar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "PATCH", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"endereco\": {\n \"numero\": \"250\",\n \"complemento\": null\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/clientes/:id", "host": [ "{{baseUrl}}" ], "path": [ "clientes", ":id" ], "variable": [ { "key": "id", "value": "cmg7h2k9x0003", "description": "O identificador do cliente." } ] }, "description": "Altera só os campos enviados — inclusive dentro de endereco.\n\n**Permissão:** `clientes:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/clientes/alterar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg7h2k9x0003\",\n \"nome\": \"Maria da Silva\",\n \"whatsapp\": \"5551999990000\",\n \"endereco\": {\n \"cep\": \"90000000\",\n \"rua\": \"Rua das Flores\",\n \"numero\": \"10\",\n \"complemento\": \"ap 2\",\n \"bairro\": \"Centro\",\n \"cidade\": \"Porto Alegre\",\n \"uf\": \"RS\"\n },\n \"criadoEm\": \"2026-09-20T09:15:00-03:00\",\n \"atualizadoEm\": \"2026-09-29T14:03:00-03:00\"\n}" } ] }, { "name": "Remover cliente", "request": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/clientes/:id", "host": [ "{{baseUrl}}" ], "path": [ "clientes", ":id" ], "variable": [ { "key": "id", "value": "cmg7h2k9x0003", "description": "O identificador do cliente." } ] }, "description": "Tira o cliente da agenda. Pedidos já feitos para ele não mudam.\n\n**Permissão:** `clientes:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/clientes/remover)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/clientes/:id", "host": [ "{{baseUrl}}" ], "path": [ "clientes", ":id" ], "variable": [ { "key": "id", "value": "cmg7h2k9x0003", "description": "O identificador do cliente." } ] }, "description": "Tira o cliente da agenda. Pedidos já feitos para ele não mudam.\n\n**Permissão:** `clientes:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/clientes/remover)" }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "body": "" } ] } ] }, { "name": "Pedidos", "item": [ { "name": "Listar pedidos", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos?limite=50", "host": [ "{{baseUrl}}" ], "path": [ "pedidos" ], "query": [ { "key": "limite", "value": "50", "description": "Itens por página, de 1 a 100.", "disabled": false }, { "key": "cursor", "value": "", "description": "O proximoCursor da resposta anterior.", "disabled": true }, { "key": "status", "value": "ENVIADO", "description": "AGUARDANDO_PAGAMENTO, PAGO, EM_SEPARACAO, ENVIADO, ENTREGUE, CANCELADO ou ESTORNADO.", "disabled": true }, { "key": "atualizadoDesde", "value": "2026-09-29T14:00:00-03:00", "description": "Só o que mudou a partir desta data (com fuso). A ordem passa a ser a de sincronização.", "disabled": true }, { "key": "de", "value": "2026-09-01T00:00:00-03:00", "description": "Criados a partir desta data.", "disabled": true }, { "key": "ate", "value": "2026-09-30T23:59:59-03:00", "description": "Criados até esta data.", "disabled": true }, { "key": "referenciaExterna", "value": "PED-778", "description": "O identificador do pedido no seu sistema.", "disabled": true }, { "key": "busca", "value": "maria", "description": "Número do pedido, destinatário, título ou SKU dos itens.", "disabled": true } ] }, "description": "Os pedidos do parceiro, com itens, destinatário e o resultado de cada um, mais o resumo do filtro. Paginado por cursor.\n\n**Permissão:** `pedidos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/listar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos?limite=50", "host": [ "{{baseUrl}}" ], "path": [ "pedidos" ], "query": [ { "key": "limite", "value": "50", "description": "Itens por página, de 1 a 100.", "disabled": false }, { "key": "cursor", "value": "", "description": "O proximoCursor da resposta anterior.", "disabled": true }, { "key": "status", "value": "ENVIADO", "description": "AGUARDANDO_PAGAMENTO, PAGO, EM_SEPARACAO, ENVIADO, ENTREGUE, CANCELADO ou ESTORNADO.", "disabled": true }, { "key": "atualizadoDesde", "value": "2026-09-29T14:00:00-03:00", "description": "Só o que mudou a partir desta data (com fuso). A ordem passa a ser a de sincronização.", "disabled": true }, { "key": "de", "value": "2026-09-01T00:00:00-03:00", "description": "Criados a partir desta data.", "disabled": true }, { "key": "ate", "value": "2026-09-30T23:59:59-03:00", "description": "Criados até esta data.", "disabled": true }, { "key": "referenciaExterna", "value": "PED-778", "description": "O identificador do pedido no seu sistema.", "disabled": true }, { "key": "busca", "value": "maria", "description": "Número do pedido, destinatário, título ou SKU dos itens.", "disabled": true } ] }, "description": "Os pedidos do parceiro, com itens, destinatário e o resultado de cada um, mais o resumo do filtro. Paginado por cursor.\n\n**Permissão:** `pedidos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/listar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"dados\": [\n {\n \"id\": \"cmg8k1p2a0007\",\n \"numero\": 12,\n \"status\": \"ENVIADO\",\n \"total\": \"279.80\",\n \"origem\": \"API\",\n \"referenciaExterna\": \"PED-778\",\n \"enviarPara\": \"CLIENTE\",\n \"clienteId\": \"cmg7h2k9x0003\",\n \"destinatario\": {\n \"nome\": \"Maria da Silva\",\n \"telefone\": \"5551999990000\",\n \"endereco\": {\n \"cep\": \"90000000\",\n \"rua\": \"Rua das Flores\",\n \"numero\": \"10\",\n \"complemento\": \"ap 2\",\n \"bairro\": \"Centro\",\n \"cidade\": \"Porto Alegre\",\n \"uf\": \"RS\"\n }\n },\n \"observacao\": \"Entregar à tarde\",\n \"itens\": [\n {\n \"id\": \"cmg8k1p2a0008\",\n \"sku\": \"320\",\n \"titulo\": \"Tênis Adidas Forum Low Branco\",\n \"imagem\": \"https://cdn.otlshoes.com.br/otl-catalog/320.webp\",\n \"numeracao\": \"38\",\n \"skuVariacao\": \"320U\",\n \"quantidade\": 2,\n \"precoAtacado\": \"139.90\",\n \"total\": \"279.80\",\n \"valorVenda\": \"259.90\",\n \"valorVendaEm\": \"2026-09-21T09:00:00-03:00\"\n }\n ],\n \"resultado\": {\n \"faturamento\": \"519.80\",\n \"custo\": \"279.80\",\n \"despesas\": \"10.00\",\n \"lucroBruto\": \"240.00\",\n \"lucro\": \"230.00\",\n \"margemPercentual\": 44.25,\n \"itens\": 2,\n \"itensSemVenda\": 0\n },\n \"criadoEm\": \"2026-09-20T09:15:00-03:00\",\n \"atualizadoEm\": \"2026-09-22T14:03:00-03:00\"\n }\n ],\n \"paginacao\": {\n \"proximoCursor\": \"eyJvIjoicmVjZW50ZXMiLCJ2IjoiMjAyNi0wOS0yMFQxMjoxNTowMC4wMDBaIiwiaWQiOiJjbWc4azFwMmEwMDA3In0\",\n \"temMais\": true\n },\n \"resumo\": {\n \"faturamento\": \"519.80\",\n \"custo\": \"279.80\",\n \"despesas\": \"10.00\",\n \"lucroBruto\": \"240.00\",\n \"lucro\": \"230.00\",\n \"margemPercentual\": 44.25,\n \"itens\": 2,\n \"itensSemVenda\": 0,\n \"pedidos\": 1\n }\n}" } ] }, { "name": "Detalhar pedido", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos/:id", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido (não o número)." } ] }, "description": "Um pedido completo: itens, resultado, despesas, rastreios e anexos. Pedido de outro parceiro responde 404.\n\n**Permissão:** `pedidos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/detalhar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos/:id", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido (não o número)." } ] }, "description": "Um pedido completo: itens, resultado, despesas, rastreios e anexos. Pedido de outro parceiro responde 404.\n\n**Permissão:** `pedidos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/detalhar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg8k1p2a0007\",\n \"numero\": 12,\n \"status\": \"ENVIADO\",\n \"total\": \"279.80\",\n \"origem\": \"API\",\n \"referenciaExterna\": \"PED-778\",\n \"enviarPara\": \"CLIENTE\",\n \"clienteId\": \"cmg7h2k9x0003\",\n \"destinatario\": {\n \"nome\": \"Maria da Silva\",\n \"telefone\": \"5551999990000\",\n \"endereco\": {\n \"cep\": \"90000000\",\n \"rua\": \"Rua das Flores\",\n \"numero\": \"10\",\n \"complemento\": \"ap 2\",\n \"bairro\": \"Centro\",\n \"cidade\": \"Porto Alegre\",\n \"uf\": \"RS\"\n }\n },\n \"observacao\": \"Entregar à tarde\",\n \"itens\": [\n {\n \"id\": \"cmg8k1p2a0008\",\n \"sku\": \"320\",\n \"titulo\": \"Tênis Adidas Forum Low Branco\",\n \"imagem\": \"https://cdn.otlshoes.com.br/otl-catalog/320.webp\",\n \"numeracao\": \"38\",\n \"skuVariacao\": \"320U\",\n \"quantidade\": 2,\n \"precoAtacado\": \"139.90\",\n \"total\": \"279.80\",\n \"valorVenda\": \"259.90\",\n \"valorVendaEm\": \"2026-09-21T09:00:00-03:00\"\n }\n ],\n \"resultado\": {\n \"faturamento\": \"519.80\",\n \"custo\": \"279.80\",\n \"despesas\": \"10.00\",\n \"lucroBruto\": \"240.00\",\n \"lucro\": \"230.00\",\n \"margemPercentual\": 44.25,\n \"itens\": 2,\n \"itensSemVenda\": 0\n },\n \"criadoEm\": \"2026-09-20T09:15:00-03:00\",\n \"atualizadoEm\": \"2026-09-22T14:03:00-03:00\",\n \"despesas\": [\n {\n \"id\": \"cmg8m3d1e0002\",\n \"descricao\": \"Embalagem\",\n \"valor\": \"10.00\",\n \"criadoEm\": \"2026-09-21T09:05:00-03:00\"\n }\n ],\n \"rastreios\": [\n {\n \"id\": \"cmg8n9q4t0001\",\n \"codigo\": \"AA123456789BR\",\n \"transportadora\": \"Correios\",\n \"validado\": true,\n \"cadastradoPeloParceiro\": false,\n \"criadoEm\": \"2026-09-22T14:03:00-03:00\"\n }\n ],\n \"anexos\": [\n {\n \"id\": \"cmg8k5z7u0004\",\n \"tipo\": \"COMPROVANTE\",\n \"nomeArquivo\": \"comprovante-pix.pdf\",\n \"tipoArquivo\": \"application/pdf\",\n \"tamanhoBytes\": 51234,\n \"validado\": true,\n \"enviadoPeloParceiro\": true,\n \"criadoEm\": \"2026-09-20T09:20:00-03:00\"\n }\n ]\n}" } ] }, { "name": "Criar pedido", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Obrigatória. Repita a MESMA chave ao tentar de novo o mesmo pedido." } ], "body": { "mode": "raw", "raw": "{\n \"itens\": [\n {\n \"sku\": \"320\",\n \"numeracao\": \"38\",\n \"quantidade\": 2,\n \"valorVenda\": \"259.90\"\n }\n ],\n \"enviarPara\": \"CLIENTE\",\n \"clienteId\": \"cmg7h2k9x0003\",\n \"referenciaExterna\": \"PED-778\",\n \"observacao\": \"Entregar à tarde\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pedidos", "host": [ "{{baseUrl}}" ], "path": [ "pedidos" ] }, "description": "Fecha um pedido de verdade: gera compromisso de pagamento com a OTL. Exige Idempotency-Key. No sandbox nada é cobrado.\n\n**Permissão:** `pedidos:criar`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/criar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Obrigatória. Repita a MESMA chave ao tentar de novo o mesmo pedido." } ], "body": { "mode": "raw", "raw": "{\n \"itens\": [\n {\n \"sku\": \"320\",\n \"numeracao\": \"38\",\n \"quantidade\": 2,\n \"valorVenda\": \"259.90\"\n }\n ],\n \"enviarPara\": \"CLIENTE\",\n \"clienteId\": \"cmg7h2k9x0003\",\n \"referenciaExterna\": \"PED-778\",\n \"observacao\": \"Entregar à tarde\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pedidos", "host": [ "{{baseUrl}}" ], "path": [ "pedidos" ] }, "description": "Fecha um pedido de verdade: gera compromisso de pagamento com a OTL. Exige Idempotency-Key. No sandbox nada é cobrado.\n\n**Permissão:** `pedidos:criar`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/criar)" }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg8k1p2a0007\",\n \"numero\": 12,\n \"status\": \"ENVIADO\",\n \"total\": \"279.80\",\n \"origem\": \"API\",\n \"referenciaExterna\": \"PED-778\",\n \"enviarPara\": \"CLIENTE\",\n \"clienteId\": \"cmg7h2k9x0003\",\n \"destinatario\": {\n \"nome\": \"Maria da Silva\",\n \"telefone\": \"5551999990000\",\n \"endereco\": {\n \"cep\": \"90000000\",\n \"rua\": \"Rua das Flores\",\n \"numero\": \"10\",\n \"complemento\": \"ap 2\",\n \"bairro\": \"Centro\",\n \"cidade\": \"Porto Alegre\",\n \"uf\": \"RS\"\n }\n },\n \"observacao\": \"Entregar à tarde\",\n \"itens\": [\n {\n \"id\": \"cmg8k1p2a0008\",\n \"sku\": \"320\",\n \"titulo\": \"Tênis Adidas Forum Low Branco\",\n \"imagem\": \"https://cdn.otlshoes.com.br/otl-catalog/320.webp\",\n \"numeracao\": \"38\",\n \"skuVariacao\": \"320U\",\n \"quantidade\": 2,\n \"precoAtacado\": \"139.90\",\n \"total\": \"279.80\",\n \"valorVenda\": \"259.90\",\n \"valorVendaEm\": \"2026-09-21T09:00:00-03:00\"\n }\n ],\n \"resultado\": {\n \"faturamento\": \"519.80\",\n \"custo\": \"279.80\",\n \"despesas\": \"10.00\",\n \"lucroBruto\": \"240.00\",\n \"lucro\": \"230.00\",\n \"margemPercentual\": 44.25,\n \"itens\": 2,\n \"itensSemVenda\": 0\n },\n \"criadoEm\": \"2026-09-20T09:15:00-03:00\",\n \"atualizadoEm\": \"2026-09-22T14:03:00-03:00\",\n \"despesas\": [\n {\n \"id\": \"cmg8m3d1e0002\",\n \"descricao\": \"Embalagem\",\n \"valor\": \"10.00\",\n \"criadoEm\": \"2026-09-21T09:05:00-03:00\"\n }\n ],\n \"rastreios\": [\n {\n \"id\": \"cmg8n9q4t0001\",\n \"codigo\": \"AA123456789BR\",\n \"transportadora\": \"Correios\",\n \"validado\": true,\n \"cadastradoPeloParceiro\": false,\n \"criadoEm\": \"2026-09-22T14:03:00-03:00\"\n }\n ],\n \"anexos\": [\n {\n \"id\": \"cmg8k5z7u0004\",\n \"tipo\": \"COMPROVANTE\",\n \"nomeArquivo\": \"comprovante-pix.pdf\",\n \"tipoArquivo\": \"application/pdf\",\n \"tamanhoBytes\": 51234,\n \"validado\": true,\n \"enviadoPeloParceiro\": true,\n \"criadoEm\": \"2026-09-20T09:20:00-03:00\"\n }\n ]\n}" } ] }, { "name": "Simular pedido", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"itens\": [\n {\n \"sku\": \"320\",\n \"numeracao\": \"38\",\n \"quantidade\": 2,\n \"valorVenda\": \"259.90\"\n }\n ],\n \"enviarPara\": \"CLIENTE\",\n \"clienteId\": \"cmg7h2k9x0003\",\n \"referenciaExterna\": \"PED-778\",\n \"observacao\": \"Entregar à tarde\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pedidos/validar", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", "validar" ] }, "description": "As mesmas checagens de Criar pedido, sem gravar nada. Para conferir estoque e preço antes de prometer a venda.\n\n**Permissão:** `pedidos:criar`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/validar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"itens\": [\n {\n \"sku\": \"320\",\n \"numeracao\": \"38\",\n \"quantidade\": 2,\n \"valorVenda\": \"259.90\"\n }\n ],\n \"enviarPara\": \"CLIENTE\",\n \"clienteId\": \"cmg7h2k9x0003\",\n \"referenciaExterna\": \"PED-778\",\n \"observacao\": \"Entregar à tarde\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pedidos/validar", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", "validar" ] }, "description": "As mesmas checagens de Criar pedido, sem gravar nada. Para conferir estoque e preço antes de prometer a venda.\n\n**Permissão:** `pedidos:criar`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/validar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"valido\": true,\n \"total\": \"279.80\",\n \"enviarPara\": \"CLIENTE\",\n \"destinatario\": {\n \"nome\": \"Maria da Silva\",\n \"telefone\": \"5551999990000\",\n \"endereco\": {\n \"cep\": \"90000000\",\n \"rua\": \"Rua das Flores\",\n \"numero\": \"10\",\n \"complemento\": \"ap 2\",\n \"bairro\": \"Centro\",\n \"cidade\": \"Porto Alegre\",\n \"uf\": \"RS\"\n }\n },\n \"itens\": [\n {\n \"indice\": 0,\n \"sku\": \"320\",\n \"titulo\": \"Tênis Adidas Forum Low Branco\",\n \"numeracao\": \"38\",\n \"skuVariacao\": \"320U\",\n \"quantidade\": 2,\n \"precoAtacado\": \"139.90\",\n \"total\": \"279.80\",\n \"disponivel\": 4\n }\n ]\n}" } ] }, { "name": "Informar valor de venda", "request": { "method": "PATCH", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"valorVenda\": \"259.90\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pedidos/:id/itens/:itemId/valor-venda", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "itens", ":itemId", "valor-venda" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "itemId", "value": "cmg8k1p2a0008", "description": "O id do item do pedido." } ] }, "description": "Por quanto o parceiro vendeu o item, por par. null limpa. Devolve o pedido com o resultado refeito.\n\n**Permissão:** `pedidos:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/valor-venda)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "PATCH", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"valorVenda\": \"259.90\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pedidos/:id/itens/:itemId/valor-venda", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "itens", ":itemId", "valor-venda" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "itemId", "value": "cmg8k1p2a0008", "description": "O id do item do pedido." } ] }, "description": "Por quanto o parceiro vendeu o item, por par. null limpa. Devolve o pedido com o resultado refeito.\n\n**Permissão:** `pedidos:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/valor-venda)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg8k1p2a0007\",\n \"numero\": 12,\n \"status\": \"ENVIADO\",\n \"total\": \"279.80\",\n \"origem\": \"API\",\n \"referenciaExterna\": \"PED-778\",\n \"enviarPara\": \"CLIENTE\",\n \"clienteId\": \"cmg7h2k9x0003\",\n \"destinatario\": {\n \"nome\": \"Maria da Silva\",\n \"telefone\": \"5551999990000\",\n \"endereco\": {\n \"cep\": \"90000000\",\n \"rua\": \"Rua das Flores\",\n \"numero\": \"10\",\n \"complemento\": \"ap 2\",\n \"bairro\": \"Centro\",\n \"cidade\": \"Porto Alegre\",\n \"uf\": \"RS\"\n }\n },\n \"observacao\": \"Entregar à tarde\",\n \"itens\": [\n {\n \"id\": \"cmg8k1p2a0008\",\n \"sku\": \"320\",\n \"titulo\": \"Tênis Adidas Forum Low Branco\",\n \"imagem\": \"https://cdn.otlshoes.com.br/otl-catalog/320.webp\",\n \"numeracao\": \"38\",\n \"skuVariacao\": \"320U\",\n \"quantidade\": 2,\n \"precoAtacado\": \"139.90\",\n \"total\": \"279.80\",\n \"valorVenda\": \"259.90\",\n \"valorVendaEm\": \"2026-09-21T09:00:00-03:00\"\n }\n ],\n \"resultado\": {\n \"faturamento\": \"519.80\",\n \"custo\": \"279.80\",\n \"despesas\": \"10.00\",\n \"lucroBruto\": \"240.00\",\n \"lucro\": \"230.00\",\n \"margemPercentual\": 44.25,\n \"itens\": 2,\n \"itensSemVenda\": 0\n },\n \"criadoEm\": \"2026-09-20T09:15:00-03:00\",\n \"atualizadoEm\": \"2026-09-22T14:03:00-03:00\",\n \"despesas\": [\n {\n \"id\": \"cmg8m3d1e0002\",\n \"descricao\": \"Embalagem\",\n \"valor\": \"10.00\",\n \"criadoEm\": \"2026-09-21T09:05:00-03:00\"\n }\n ],\n \"rastreios\": [\n {\n \"id\": \"cmg8n9q4t0001\",\n \"codigo\": \"AA123456789BR\",\n \"transportadora\": \"Correios\",\n \"validado\": true,\n \"cadastradoPeloParceiro\": false,\n \"criadoEm\": \"2026-09-22T14:03:00-03:00\"\n }\n ],\n \"anexos\": [\n {\n \"id\": \"cmg8k5z7u0004\",\n \"tipo\": \"COMPROVANTE\",\n \"nomeArquivo\": \"comprovante-pix.pdf\",\n \"tipoArquivo\": \"application/pdf\",\n \"tamanhoBytes\": 51234,\n \"validado\": true,\n \"enviadoPeloParceiro\": true,\n \"criadoEm\": \"2026-09-20T09:20:00-03:00\"\n }\n ]\n}" } ] }, { "name": "Lançar despesa", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"descricao\": \"Embalagem\",\n \"valor\": \"10.00\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pedidos/:id/despesas", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "despesas" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." } ] }, "description": "Um custo do parceiro no pedido (frete, embalagem, taxa). Entra no resultado. Aceita Idempotency-Key.\n\n**Permissão:** `pedidos:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/despesas-criar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"descricao\": \"Embalagem\",\n \"valor\": \"10.00\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pedidos/:id/despesas", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "despesas" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." } ] }, "description": "Um custo do parceiro no pedido (frete, embalagem, taxa). Entra no resultado. Aceita Idempotency-Key.\n\n**Permissão:** `pedidos:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/despesas-criar)" }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg8m3d1e0002\",\n \"descricao\": \"Embalagem\",\n \"valor\": \"10.00\",\n \"criadoEm\": \"2026-09-21T09:05:00-03:00\"\n}" } ] }, { "name": "Remover despesa", "request": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos/:id/despesas/:despesaId", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "despesas", ":despesaId" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "despesaId", "value": "cmg8m3d1e0002", "description": "O id da despesa." } ] }, "description": "Apaga uma despesa lançada no pedido.\n\n**Permissão:** `pedidos:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/despesas-remover)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos/:id/despesas/:despesaId", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "despesas", ":despesaId" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "despesaId", "value": "cmg8m3d1e0002", "description": "O id da despesa." } ] }, "description": "Apaga uma despesa lançada no pedido.\n\n**Permissão:** `pedidos:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/despesas-remover)" }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "body": "" } ] }, { "name": "Cadastrar rastreio", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"codigo\": \"AA123456789BR\",\n \"transportadora\": \"Correios\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pedidos/:id/rastreios", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "rastreios" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." } ] }, "description": "Acrescenta um código de rastreio ao pedido. Aceita Idempotency-Key.\n\n**Permissão:** `pedidos:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/rastreios-criar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"codigo\": \"AA123456789BR\",\n \"transportadora\": \"Correios\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pedidos/:id/rastreios", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "rastreios" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." } ] }, "description": "Acrescenta um código de rastreio ao pedido. Aceita Idempotency-Key.\n\n**Permissão:** `pedidos:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/rastreios-criar)" }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg8n9q4t0001\",\n \"codigo\": \"AA123456789BR\",\n \"transportadora\": \"Correios\",\n \"validado\": false,\n \"cadastradoPeloParceiro\": true,\n \"criadoEm\": \"2026-09-22T14:03:00-03:00\"\n}" } ] }, { "name": "Remover rastreio", "request": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos/:id/rastreios/:rastreioId", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "rastreios", ":rastreioId" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "rastreioId", "value": "cmg8n9q4t0001", "description": "O id do rastreio." } ] }, "description": "Apaga um rastreio cadastrado pelo parceiro e ainda não validado pela OTL.\n\n**Permissão:** `pedidos:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/rastreios-remover)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos/:id/rastreios/:rastreioId", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "rastreios", ":rastreioId" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "rastreioId", "value": "cmg8n9q4t0001", "description": "O id do rastreio." } ] }, "description": "Apaga um rastreio cadastrado pelo parceiro e ainda não validado pela OTL.\n\n**Permissão:** `pedidos:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/rastreios-remover)" }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "body": "" } ] }, { "name": "Enviar comprovante", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "arquivo", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/pedidos/:id/anexos", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "anexos" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." } ] }, "description": "Anexa o comprovante de pagamento (multipart/form-data, campo \"arquivo\"). PDF, JPG, PNG ou WebP, até 10 MB.\n\n**Permissão:** `pedidos:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/anexos-enviar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "arquivo", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/pedidos/:id/anexos", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "anexos" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." } ] }, "description": "Anexa o comprovante de pagamento (multipart/form-data, campo \"arquivo\"). PDF, JPG, PNG ou WebP, até 10 MB.\n\n**Permissão:** `pedidos:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/anexos-enviar)" }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg8k5z7u0004\",\n \"tipo\": \"COMPROVANTE\",\n \"nomeArquivo\": \"comprovante-pix.pdf\",\n \"tipoArquivo\": \"application/pdf\",\n \"tamanhoBytes\": 51234,\n \"validado\": false,\n \"enviadoPeloParceiro\": true,\n \"criadoEm\": \"2026-09-20T09:20:00-03:00\"\n}" } ] }, { "name": "Baixar anexo", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." } ], "url": { "raw": "{{baseUrl}}/pedidos/:id/anexos/:anexoId/arquivo", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "anexos", ":anexoId", "arquivo" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "anexoId", "value": "cmg8k5z7u0004", "description": "O id do anexo." } ] }, "description": "O arquivo de qualquer anexo do pedido (comprovante, etiqueta, nota fiscal). A resposta é o arquivo, não JSON.\n\n**Permissão:** `pedidos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/anexos-baixar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." } ], "url": { "raw": "{{baseUrl}}/pedidos/:id/anexos/:anexoId/arquivo", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "anexos", ":anexoId", "arquivo" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "anexoId", "value": "cmg8k5z7u0004", "description": "O id do anexo." } ] }, "description": "O arquivo de qualquer anexo do pedido (comprovante, etiqueta, nota fiscal). A resposta é o arquivo, não JSON.\n\n**Permissão:** `pedidos:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/anexos-baixar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/pdf" } ], "body": "(o conteúdo do arquivo)" } ] }, { "name": "Remover comprovante", "request": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos/:id/anexos/:anexoId", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "anexos", ":anexoId" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "anexoId", "value": "cmg8k5z7u0004", "description": "O id do anexo." } ] }, "description": "Apaga um comprovante enviado pelo parceiro e ainda não validado pela OTL.\n\n**Permissão:** `pedidos:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/anexos-remover)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos/:id/anexos/:anexoId", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "anexos", ":anexoId" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "anexoId", "value": "cmg8k5z7u0004", "description": "O id do anexo." } ] }, "description": "Apaga um comprovante enviado pelo parceiro e ainda não validado pela OTL.\n\n**Permissão:** `pedidos:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/pedidos/anexos-remover)" }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "body": "" } ] } ] }, { "name": "Financeiro", "item": [ { "name": "Saldo", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/financeiro/saldo", "host": [ "{{baseUrl}}" ], "path": [ "financeiro", "saldo" ] }, "description": "O saldo do parceiro com a OTL, acumulado. Informativo: não abate pedidos automaticamente.\n\n**Permissão:** `financeiro:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/financeiro/saldo)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/financeiro/saldo", "host": [ "{{baseUrl}}" ], "path": [ "financeiro", "saldo" ] }, "description": "O saldo do parceiro com a OTL, acumulado. Informativo: não abate pedidos automaticamente.\n\n**Permissão:** `financeiro:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/financeiro/saldo)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"saldo\": \"109.50\",\n \"creditos\": \"150.00\",\n \"debitos\": \"40.50\"\n}" } ] }, { "name": "Extrato", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/financeiro/extrato?limite=50", "host": [ "{{baseUrl}}" ], "path": [ "financeiro", "extrato" ], "query": [ { "key": "limite", "value": "50", "description": "Itens por página, de 1 a 100.", "disabled": false }, { "key": "cursor", "value": "", "description": "O proximoCursor da resposta anterior.", "disabled": true }, { "key": "de", "value": "2026-09-01T00:00:00-03:00", "description": "Lançamentos a partir desta data.", "disabled": true }, { "key": "ate", "value": "2026-09-30T23:59:59-03:00", "description": "Lançamentos até esta data.", "disabled": true } ] }, "description": "Os lançamentos do saldo, do mais recente para o mais antigo. Paginado por cursor.\n\n**Permissão:** `financeiro:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/financeiro/extrato)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/financeiro/extrato?limite=50", "host": [ "{{baseUrl}}" ], "path": [ "financeiro", "extrato" ], "query": [ { "key": "limite", "value": "50", "description": "Itens por página, de 1 a 100.", "disabled": false }, { "key": "cursor", "value": "", "description": "O proximoCursor da resposta anterior.", "disabled": true }, { "key": "de", "value": "2026-09-01T00:00:00-03:00", "description": "Lançamentos a partir desta data.", "disabled": true }, { "key": "ate", "value": "2026-09-30T23:59:59-03:00", "description": "Lançamentos até esta data.", "disabled": true } ] }, "description": "Os lançamentos do saldo, do mais recente para o mais antigo. Paginado por cursor.\n\n**Permissão:** `financeiro:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/financeiro/extrato)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"dados\": [\n {\n \"id\": \"cmg9a2b3c0002\",\n \"tipo\": \"DEBITO\",\n \"valor\": \"-40.50\",\n \"descricao\": \"Ajuste de frete\",\n \"pedido\": null,\n \"criadoEm\": \"2026-09-27T10:30:00-03:00\"\n },\n {\n \"id\": \"cmg9a2b3c0001\",\n \"tipo\": \"CREDITO\",\n \"valor\": \"150.00\",\n \"descricao\": \"Devolução do pedido #12\",\n \"pedido\": {\n \"id\": \"cmg8k1p2a0007\",\n \"numero\": 12\n },\n \"criadoEm\": \"2026-09-25T09:00:00-03:00\"\n }\n ],\n \"paginacao\": {\n \"proximoCursor\": null,\n \"temMais\": false\n }\n}" } ] } ] }, { "name": "Etiquetas", "item": [ { "name": "Conta SuperFrete", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/superfrete", "host": [ "{{baseUrl}}" ], "path": [ "superfrete" ] }, "description": "Se o parceiro tem conta SuperFrete conectada e quanto há de saldo na carteira dele.\n\n**Permissão:** `etiquetas:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/etiquetas/conta-superfrete)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/superfrete", "host": [ "{{baseUrl}}" ], "path": [ "superfrete" ] }, "description": "Se o parceiro tem conta SuperFrete conectada e quanto há de saldo na carteira dele.\n\n**Permissão:** `etiquetas:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/etiquetas/conta-superfrete)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"conectada\": true,\n \"ambiente\": \"producao\",\n \"conta\": {\n \"nome\": \"João da Silva\",\n \"conectadaEm\": \"2026-09-01T09:00:00-03:00\"\n },\n \"saldo\": \"87.50\"\n}" } ] }, { "name": "Cotar frete", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos/:id/etiquetas/cotacao", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "etiquetas", "cotacao" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." } ] }, "description": "As opções de frete do pedido, com o preço da conta do parceiro. Não consome saldo.\n\n**Permissão:** `etiquetas:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/etiquetas/cotar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos/:id/etiquetas/cotacao", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "etiquetas", "cotacao" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." } ] }, "description": "As opções de frete do pedido, com o preço da conta do parceiro. Não consome saldo.\n\n**Permissão:** `etiquetas:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/etiquetas/cotar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"cotacoes\": [\n {\n \"servico\": {\n \"id\": 17,\n \"nome\": \"Mini Envios\"\n },\n \"transportadora\": \"Correios\",\n \"valor\": \"14.90\",\n \"prazoDias\": 7\n },\n {\n \"servico\": {\n \"id\": 1,\n \"nome\": \"PAC\"\n },\n \"transportadora\": \"Correios\",\n \"valor\": \"23.72\",\n \"prazoDias\": 5\n },\n {\n \"servico\": {\n \"id\": 2,\n \"nome\": \"SEDEX\"\n },\n \"transportadora\": \"Correios\",\n \"valor\": \"38.10\",\n \"prazoDias\": 2\n }\n ]\n}" } ] }, { "name": "Emitir etiqueta", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Obrigatória. Repita a MESMA chave ao tentar de novo o mesmo pedido." } ], "body": { "mode": "raw", "raw": "{\n \"servico\": 1,\n \"documentoDestinatario\": \"529.982.247-25\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pedidos/:id/etiquetas", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "etiquetas" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." } ] }, "description": "Cria e PAGA a etiqueta: debita a carteira SuperFrete do parceiro. Idempotency-Key obrigatória.\n\n**Permissão:** `etiquetas:emitir`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/etiquetas/emitir)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Obrigatória. Repita a MESMA chave ao tentar de novo o mesmo pedido." } ], "body": { "mode": "raw", "raw": "{\n \"servico\": 1,\n \"documentoDestinatario\": \"529.982.247-25\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pedidos/:id/etiquetas", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "etiquetas" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." } ] }, "description": "Cria e PAGA a etiqueta: debita a carteira SuperFrete do parceiro. Idempotency-Key obrigatória.\n\n**Permissão:** `etiquetas:emitir`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/etiquetas/emitir)" }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg8p2r5v0003\",\n \"pedido\": {\n \"id\": \"cmg8k1p2a0007\",\n \"numero\": 12\n },\n \"servico\": {\n \"id\": 1,\n \"nome\": \"PAC\"\n },\n \"transportadora\": \"PAC\",\n \"valor\": \"23.72\",\n \"status\": \"GERADA\",\n \"rastreio\": \"AA123456789BR\",\n \"emitidaEm\": \"2026-09-21T11:00:00-03:00\",\n \"impressaEm\": null,\n \"despachadaEm\": null,\n \"canceladaEm\": null,\n \"atualizadoEm\": \"2026-09-21T11:00:00-03:00\"\n}" } ] }, { "name": "Etiquetas do pedido", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos/:id/etiquetas", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "etiquetas" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." } ] }, "description": "As etiquetas do pedido, com status e rastreio — inclusive as canceladas.\n\n**Permissão:** `etiquetas:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/etiquetas/listar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos/:id/etiquetas", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "etiquetas" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." } ] }, "description": "As etiquetas do pedido, com status e rastreio — inclusive as canceladas.\n\n**Permissão:** `etiquetas:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/etiquetas/listar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"etiquetas\": [\n {\n \"id\": \"cmg8p2r5v0003\",\n \"pedido\": {\n \"id\": \"cmg8k1p2a0007\",\n \"numero\": 12\n },\n \"servico\": {\n \"id\": 1,\n \"nome\": \"PAC\"\n },\n \"transportadora\": \"PAC\",\n \"valor\": \"23.72\",\n \"status\": \"GERADA\",\n \"rastreio\": \"AA123456789BR\",\n \"emitidaEm\": \"2026-09-21T11:00:00-03:00\",\n \"impressaEm\": null,\n \"despachadaEm\": null,\n \"canceladaEm\": null,\n \"atualizadoEm\": \"2026-09-21T11:00:00-03:00\"\n }\n ]\n}" } ] }, { "name": "Cancelar etiqueta", "request": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos/:id/etiquetas/:etiquetaId", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "etiquetas", ":etiquetaId" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "etiquetaId", "value": "cmg8p2r5v0003", "description": "O id da etiqueta." } ] }, "description": "Cancela a etiqueta e estorna o valor na carteira SuperFrete do parceiro. Só antes de despachada.\n\n**Permissão:** `etiquetas:emitir`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/etiquetas/cancelar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pedidos/:id/etiquetas/:etiquetaId", "host": [ "{{baseUrl}}" ], "path": [ "pedidos", ":id", "etiquetas", ":etiquetaId" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "etiquetaId", "value": "cmg8p2r5v0003", "description": "O id da etiqueta." } ] }, "description": "Cancela a etiqueta e estorna o valor na carteira SuperFrete do parceiro. Só antes de despachada.\n\n**Permissão:** `etiquetas:emitir`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/etiquetas/cancelar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg8p2r5v0003\",\n \"pedido\": {\n \"id\": \"cmg8k1p2a0007\",\n \"numero\": 12\n },\n \"servico\": {\n \"id\": 1,\n \"nome\": \"PAC\"\n },\n \"transportadora\": \"PAC\",\n \"valor\": \"23.72\",\n \"status\": \"CANCELADA\",\n \"rastreio\": \"AA123456789BR\",\n \"emitidaEm\": \"2026-09-21T11:00:00-03:00\",\n \"impressaEm\": null,\n \"despachadaEm\": null,\n \"canceladaEm\": \"2026-09-21T15:40:00-03:00\",\n \"atualizadoEm\": \"2026-09-21T11:00:00-03:00\"\n}" } ] } ] }, { "name": "Loja-hub", "item": [ { "name": "Ver a loja", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub" ] }, "description": "A configuração da loja do parceiro no HUB, a URL pública e o que falta para publicar.\n\n**Permissão:** `loja-hub:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/ver)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub" ] }, "description": "A configuração da loja do parceiro no HUB, a URL pública e o que falta para publicar.\n\n**Permissão:** `loja-hub:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/ver)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"url\": \"https://hubshoes.com.br/joao-calcados\",\n \"endereco\": \"joao-calcados\",\n \"publicada\": true,\n \"nome\": \"João Calçados\",\n \"chamada\": \"Tênis originais com entrega para todo o Brasil\",\n \"sobre\": \"Loja de Canoas (RS), no ar desde 2021.\",\n \"logoUrl\": \"https://cdn.otlshoes.com.br/otl-catalog/hub/logos/joao.webp\",\n \"ocultarNome\": false,\n \"corDestaque\": \"#f97316\",\n \"preco\": {\n \"tipoAcrescimo\": \"PERCENTUAL\",\n \"acrescimo\": \"50.00\",\n \"arredondar\": true\n },\n \"modoSelecao\": \"MANUAL\",\n \"freteNoSite\": true,\n \"seo\": {\n \"titulo\": \"João Calçados — tênis originais\",\n \"descricao\": \"Tênis casuais e esportivos com envio para todo o Brasil.\"\n },\n \"contexto\": {\n \"nicho\": \"tênis casual masculino\",\n \"regiao\": \"Grande Porto Alegre\",\n \"tomDeVoz\": \"direto e descontraído\"\n },\n \"publicacao\": {\n \"temWhatsapp\": true,\n \"temEndereco\": true,\n \"temProdutos\": true,\n \"podePublicar\": true\n },\n \"criadoEm\": \"2026-09-05T09:00:00-03:00\",\n \"atualizadoEm\": \"2026-09-28T16:20:00-03:00\"\n}" } ] }, { "name": "Alterar a loja", "request": { "method": "PATCH", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"nome\": \"João Calçados\",\n \"preco\": {\n \"tipoAcrescimo\": \"PERCENTUAL\",\n \"acrescimo\": \"50.00\",\n \"arredondar\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loja-hub", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub" ] }, "description": "Altera nome, endereço, textos, cor, acréscimo de preço, SEO e frete no site. Só o que vier muda.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/alterar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "PATCH", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"nome\": \"João Calçados\",\n \"preco\": {\n \"tipoAcrescimo\": \"PERCENTUAL\",\n \"acrescimo\": \"50.00\",\n \"arredondar\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loja-hub", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub" ] }, "description": "Altera nome, endereço, textos, cor, acréscimo de preço, SEO e frete no site. Só o que vier muda.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/alterar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"url\": \"https://hubshoes.com.br/joao-calcados\",\n \"endereco\": \"joao-calcados\",\n \"publicada\": true,\n \"nome\": \"João Calçados\",\n \"chamada\": \"Tênis originais com entrega para todo o Brasil\",\n \"sobre\": \"Loja de Canoas (RS), no ar desde 2021.\",\n \"logoUrl\": \"https://cdn.otlshoes.com.br/otl-catalog/hub/logos/joao.webp\",\n \"ocultarNome\": false,\n \"corDestaque\": \"#f97316\",\n \"preco\": {\n \"tipoAcrescimo\": \"PERCENTUAL\",\n \"acrescimo\": \"50.00\",\n \"arredondar\": true\n },\n \"modoSelecao\": \"MANUAL\",\n \"freteNoSite\": true,\n \"seo\": {\n \"titulo\": \"João Calçados — tênis originais\",\n \"descricao\": \"Tênis casuais e esportivos com envio para todo o Brasil.\"\n },\n \"contexto\": {\n \"nicho\": \"tênis casual masculino\",\n \"regiao\": \"Grande Porto Alegre\",\n \"tomDeVoz\": \"direto e descontraído\"\n },\n \"publicacao\": {\n \"temWhatsapp\": true,\n \"temEndereco\": true,\n \"temProdutos\": true,\n \"podePublicar\": true\n },\n \"criadoEm\": \"2026-09-05T09:00:00-03:00\",\n \"atualizadoEm\": \"2026-09-28T16:20:00-03:00\"\n}" } ] }, { "name": "Publicar", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/publicar", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "publicar" ] }, "description": "Põe a vitrine no ar. Recusa enquanto faltar WhatsApp da loja, endereço ou produto.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/publicar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/publicar", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "publicar" ] }, "description": "Põe a vitrine no ar. Recusa enquanto faltar WhatsApp da loja, endereço ou produto.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/publicar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"url\": \"https://hubshoes.com.br/joao-calcados\",\n \"endereco\": \"joao-calcados\",\n \"publicada\": true,\n \"nome\": \"João Calçados\",\n \"chamada\": \"Tênis originais com entrega para todo o Brasil\",\n \"sobre\": \"Loja de Canoas (RS), no ar desde 2021.\",\n \"logoUrl\": \"https://cdn.otlshoes.com.br/otl-catalog/hub/logos/joao.webp\",\n \"ocultarNome\": false,\n \"corDestaque\": \"#f97316\",\n \"preco\": {\n \"tipoAcrescimo\": \"PERCENTUAL\",\n \"acrescimo\": \"50.00\",\n \"arredondar\": true\n },\n \"modoSelecao\": \"MANUAL\",\n \"freteNoSite\": true,\n \"seo\": {\n \"titulo\": \"João Calçados — tênis originais\",\n \"descricao\": \"Tênis casuais e esportivos com envio para todo o Brasil.\"\n },\n \"contexto\": {\n \"nicho\": \"tênis casual masculino\",\n \"regiao\": \"Grande Porto Alegre\",\n \"tomDeVoz\": \"direto e descontraído\"\n },\n \"publicacao\": {\n \"temWhatsapp\": true,\n \"temEndereco\": true,\n \"temProdutos\": true,\n \"podePublicar\": true\n },\n \"criadoEm\": \"2026-09-05T09:00:00-03:00\",\n \"atualizadoEm\": \"2026-09-28T16:20:00-03:00\"\n}" } ] }, { "name": "Despublicar", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/despublicar", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "despublicar" ] }, "description": "Tira a vitrine do ar, sem apagar nada.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/despublicar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/despublicar", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "despublicar" ] }, "description": "Tira a vitrine do ar, sem apagar nada.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/despublicar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"url\": \"https://hubshoes.com.br/joao-calcados\",\n \"endereco\": \"joao-calcados\",\n \"publicada\": false,\n \"nome\": \"João Calçados\",\n \"chamada\": \"Tênis originais com entrega para todo o Brasil\",\n \"sobre\": \"Loja de Canoas (RS), no ar desde 2021.\",\n \"logoUrl\": \"https://cdn.otlshoes.com.br/otl-catalog/hub/logos/joao.webp\",\n \"ocultarNome\": false,\n \"corDestaque\": \"#f97316\",\n \"preco\": {\n \"tipoAcrescimo\": \"PERCENTUAL\",\n \"acrescimo\": \"50.00\",\n \"arredondar\": true\n },\n \"modoSelecao\": \"MANUAL\",\n \"freteNoSite\": true,\n \"seo\": {\n \"titulo\": \"João Calçados — tênis originais\",\n \"descricao\": \"Tênis casuais e esportivos com envio para todo o Brasil.\"\n },\n \"contexto\": {\n \"nicho\": \"tênis casual masculino\",\n \"regiao\": \"Grande Porto Alegre\",\n \"tomDeVoz\": \"direto e descontraído\"\n },\n \"publicacao\": {\n \"temWhatsapp\": true,\n \"temEndereco\": true,\n \"temProdutos\": true,\n \"podePublicar\": true\n },\n \"criadoEm\": \"2026-09-05T09:00:00-03:00\",\n \"atualizadoEm\": \"2026-09-28T16:20:00-03:00\"\n}" } ] }, { "name": "Ver a seleção", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/selecao", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "selecao" ] }, "description": "Quais produtos a vitrine vende: o catálogo inteiro, categorias ou uma lista de SKUs.\n\n**Permissão:** `loja-hub:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/selecao-ver)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/selecao", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "selecao" ] }, "description": "Quais produtos a vitrine vende: o catálogo inteiro, categorias ou uma lista de SKUs.\n\n**Permissão:** `loja-hub:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/selecao-ver)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"modo\": \"MANUAL\",\n \"categorias\": [],\n \"skus\": [\n \"320\",\n \"411\"\n ]\n}" } ] }, { "name": "Definir a seleção", "request": { "method": "PUT", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"modo\": \"MANUAL\",\n \"skus\": [\n \"320\",\n \"411\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loja-hub/selecao", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "selecao" ] }, "description": "Substitui a seleção inteira: o que não vier foi desmarcado.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/selecao-definir)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "PUT", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"modo\": \"MANUAL\",\n \"skus\": [\n \"320\",\n \"411\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loja-hub/selecao", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "selecao" ] }, "description": "Substitui a seleção inteira: o que não vier foi desmarcado.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/selecao-definir)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"modo\": \"MANUAL\",\n \"categorias\": [],\n \"skus\": [\n \"320\",\n \"411\"\n ]\n}" } ] }, { "name": "Estatísticas", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/estatisticas?dias=30", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "estatisticas" ], "query": [ { "key": "dias", "value": "30", "description": "Tamanho da janela, de 7 a 90 dias. Padrão 30.", "disabled": false } ] }, "description": "Visitas, visitantes e cliques no WhatsApp da vitrine, por origem e por dia.\n\n**Permissão:** `loja-hub:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/estatisticas)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/estatisticas?dias=30", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "estatisticas" ], "query": [ { "key": "dias", "value": "30", "description": "Tamanho da janela, de 7 a 90 dias. Padrão 30.", "disabled": false } ] }, "description": "Visitas, visitantes e cliques no WhatsApp da vitrine, por origem e por dia.\n\n**Permissão:** `loja-hub:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/estatisticas)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"dias\": 30,\n \"total\": {\n \"visitas\": 1240,\n \"visitantes\": 870,\n \"visitasAProduto\": 610,\n \"adicoesAoCarrinho\": 95,\n \"cliquesNoWhatsapp\": 42,\n \"conversao\": 3.4\n },\n \"porOrigem\": [\n {\n \"origem\": \"instagram\",\n \"visitas\": 800,\n \"visitantes\": 560,\n \"visitasAProduto\": 400,\n \"adicoesAoCarrinho\": 60,\n \"cliquesNoWhatsapp\": 30\n },\n {\n \"origem\": \"direto\",\n \"visitas\": 440,\n \"visitantes\": 310,\n \"visitasAProduto\": 210,\n \"adicoesAoCarrinho\": 35,\n \"cliquesNoWhatsapp\": 12\n }\n ],\n \"porDia\": [\n {\n \"dia\": \"2026-09-28\",\n \"visitas\": 52,\n \"visitantes\": 40,\n \"visitasAProduto\": 25,\n \"adicoesAoCarrinho\": 4,\n \"cliquesNoWhatsapp\": 2\n },\n {\n \"dia\": \"2026-09-29\",\n \"visitas\": 61,\n \"visitantes\": 47,\n \"visitasAProduto\": 30,\n \"adicoesAoCarrinho\": 6,\n \"cliquesNoWhatsapp\": 3\n }\n ]\n}" } ] }, { "name": "Ver a aparência", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/aparencia", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "aparencia" ] }, "description": "Cores, fonte, cabeçalho e card do produto da vitrine.\n\n**Permissão:** `loja-hub:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/aparencia-ver)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/aparencia", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "aparencia" ] }, "description": "Cores, fonte, cabeçalho e card do produto da vitrine.\n\n**Permissão:** `loja-hub:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/aparencia-ver)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"corFundo\": \"#f5f6f7\",\n \"corTexto\": \"#14161a\",\n \"fonte\": \"poppins\",\n \"cantos\": \"suave\",\n \"estiloCard\": \"borda\",\n \"formatoLogo\": \"auto\",\n \"cabecalho\": \"destaque\",\n \"corCabecalho\": \"#ffffff\",\n \"botao\": \"solido\",\n \"rotuloBotao\": \"Ver detalhes\",\n \"enquadramentoFoto\": \"inteira\",\n \"mostrarNumeracoes\": true\n}" } ] }, { "name": "Definir a aparência", "request": { "method": "PUT", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"fonte\": \"poppins\",\n \"cabecalho\": \"destaque\",\n \"botao\": \"solido\",\n \"rotuloBotao\": \"Ver detalhes\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loja-hub/aparencia", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "aparencia" ] }, "description": "Altera a aparência dentro de um conjunto fechado de opções. Só o que vier muda.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/aparencia-definir)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "PUT", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"fonte\": \"poppins\",\n \"cabecalho\": \"destaque\",\n \"botao\": \"solido\",\n \"rotuloBotao\": \"Ver detalhes\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loja-hub/aparencia", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "aparencia" ] }, "description": "Altera a aparência dentro de um conjunto fechado de opções. Só o que vier muda.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/aparencia-definir)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"corFundo\": \"#f5f6f7\",\n \"corTexto\": \"#14161a\",\n \"fonte\": \"poppins\",\n \"cantos\": \"suave\",\n \"estiloCard\": \"borda\",\n \"formatoLogo\": \"auto\",\n \"cabecalho\": \"destaque\",\n \"corCabecalho\": \"#ffffff\",\n \"botao\": \"solido\",\n \"rotuloBotao\": \"Ver detalhes\",\n \"enquadramentoFoto\": \"inteira\",\n \"mostrarNumeracoes\": true\n}" } ] }, { "name": "Listar banners", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/banners", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "banners" ] }, "description": "Os banners da vitrine, na ordem em que aparecem.\n\n**Permissão:** `loja-hub:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/banners-listar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/banners", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "banners" ] }, "description": "Os banners da vitrine, na ordem em que aparecem.\n\n**Permissão:** `loja-hub:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/banners-listar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"banners\": [\n {\n \"id\": \"cmh1b2c3d0001\",\n \"imagemUrl\": \"https://cdn.otlshoes.com.br/otl-catalog/hub/banners/inverno.webp\",\n \"descricao\": \"Promoção de inverno\",\n \"link\": \"https://hubshoes.com.br/joao-calcados?marca=casual\",\n \"posicao\": 0,\n \"ativo\": true,\n \"criadoEm\": \"2026-09-10T10:00:00-03:00\"\n }\n ]\n}" } ] }, { "name": "Enviar banner", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "imagem", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/loja-hub/banners", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "banners" ] }, "description": "Envia a imagem de um banner (multipart/form-data, campo \"imagem\"). JPG, PNG ou WebP, até 5 MB.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/banners-enviar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "imagem", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/loja-hub/banners", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "banners" ] }, "description": "Envia a imagem de um banner (multipart/form-data, campo \"imagem\"). JPG, PNG ou WebP, até 5 MB.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/banners-enviar)" }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmh1b2c3d0001\",\n \"imagemUrl\": \"https://cdn.otlshoes.com.br/otl-catalog/hub/banners/inverno.webp\",\n \"descricao\": \"Promoção de inverno\",\n \"link\": \"https://hubshoes.com.br/joao-calcados?marca=casual\",\n \"posicao\": 0,\n \"ativo\": true,\n \"criadoEm\": \"2026-09-10T10:00:00-03:00\"\n}" } ] }, { "name": "Alterar banner", "request": { "method": "PATCH", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ativo\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loja-hub/banners/:bannerId", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "banners", ":bannerId" ], "variable": [ { "key": "bannerId", "value": "cmh1b2c3d0001", "description": "O id do banner." } ] }, "description": "Altera a descrição, o link ou liga/desliga um banner.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/banners-alterar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "PATCH", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ativo\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loja-hub/banners/:bannerId", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "banners", ":bannerId" ], "variable": [ { "key": "bannerId", "value": "cmh1b2c3d0001", "description": "O id do banner." } ] }, "description": "Altera a descrição, o link ou liga/desliga um banner.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/banners-alterar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmh1b2c3d0001\",\n \"imagemUrl\": \"https://cdn.otlshoes.com.br/otl-catalog/hub/banners/inverno.webp\",\n \"descricao\": \"Promoção de inverno\",\n \"link\": \"https://hubshoes.com.br/joao-calcados?marca=casual\",\n \"posicao\": 0,\n \"ativo\": true,\n \"criadoEm\": \"2026-09-10T10:00:00-03:00\"\n}" } ] }, { "name": "Ordenar banners", "request": { "method": "PUT", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"cmh1b2c3d0001\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loja-hub/banners/ordem", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "banners", "ordem" ] }, "description": "Define a ordem dos banners, com a lista inteira de ids.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/banners-ordenar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "PUT", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"cmh1b2c3d0001\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loja-hub/banners/ordem", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "banners", "ordem" ] }, "description": "Define a ordem dos banners, com a lista inteira de ids.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/banners-ordenar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"banners\": [\n {\n \"id\": \"cmh1b2c3d0001\",\n \"imagemUrl\": \"https://cdn.otlshoes.com.br/otl-catalog/hub/banners/inverno.webp\",\n \"descricao\": \"Promoção de inverno\",\n \"link\": \"https://hubshoes.com.br/joao-calcados?marca=casual\",\n \"posicao\": 0,\n \"ativo\": true,\n \"criadoEm\": \"2026-09-10T10:00:00-03:00\"\n }\n ]\n}" } ] }, { "name": "Remover banner", "request": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/banners/:bannerId", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "banners", ":bannerId" ], "variable": [ { "key": "bannerId", "value": "cmh1b2c3d0001", "description": "O id do banner." } ] }, "description": "Apaga o banner e a imagem dele.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/banners-remover)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/banners/:bannerId", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "banners", ":bannerId" ], "variable": [ { "key": "bannerId", "value": "cmh1b2c3d0001", "description": "O id do banner." } ] }, "description": "Apaga o banner e a imagem dele.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/banners-remover)" }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "body": "" } ] }, { "name": "Enviar logo", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "imagem", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/loja-hub/logo", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "logo" ] }, "description": "Envia o logo da loja (multipart/form-data, campo \"imagem\"). Substitui o atual.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/logo-enviar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "imagem", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/loja-hub/logo", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "logo" ] }, "description": "Envia o logo da loja (multipart/form-data, campo \"imagem\"). Substitui o atual.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/logo-enviar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"logoUrl\": \"https://cdn.otlshoes.com.br/otl-catalog/hub/logos/joao.webp\"\n}" } ] }, { "name": "Remover logo", "request": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/logo", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "logo" ] }, "description": "Apaga o logo da loja.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/logo-remover)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/logo", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "logo" ] }, "description": "Apaga o logo da loja.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/logo-remover)" }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "body": "" } ] }, { "name": "Ver texto do produto", "request": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/seo/produtos/:sku", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "seo", "produtos", ":sku" ], "variable": [ { "key": "sku", "value": "320", "description": "O SKU do produto." } ] }, "description": "O texto próprio de um produto nesta loja (título, descrição e conteúdo para o Google).\n\n**Permissão:** `loja-hub:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/seo-ver)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "GET", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/seo/produtos/:sku", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "seo", "produtos", ":sku" ], "variable": [ { "key": "sku", "value": "320", "description": "O SKU do produto." } ] }, "description": "O texto próprio de um produto nesta loja (título, descrição e conteúdo para o Google).\n\n**Permissão:** `loja-hub:ler`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/seo-ver)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"sku\": \"320\",\n \"endereco\": \"tenis-adidas-forum-low-branco-320\",\n \"titulo\": \"Tênis Adidas Forum Low Branco\",\n \"descricao\": \"Clássico do basquete dos anos 80, em couro branco. Calça normal.\",\n \"texto\": \"O Forum Low nasceu nas quadras e virou peça de rua. Cabedal em couro, tira no tornozelo e solado de borracha.\",\n \"palavrasChave\": [\n \"adidas forum low\",\n \"tênis branco masculino\"\n ],\n \"origem\": \"MANUAL\",\n \"publicado\": true,\n \"publicadoEm\": \"2026-09-20T11:00:00-03:00\",\n \"atualizadoEm\": \"2026-09-20T11:00:00-03:00\"\n}" } ] }, { "name": "Gravar texto do produto", "request": { "method": "PUT", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"titulo\": \"Tênis Adidas Forum Low Branco\",\n \"descricao\": \"Clássico do basquete dos anos 80, em couro branco. Calça normal.\",\n \"publicar\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loja-hub/seo/produtos/:sku", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "seo", "produtos", ":sku" ], "variable": [ { "key": "sku", "value": "320", "description": "O SKU do produto." } ] }, "description": "Grava o texto próprio do produto nesta loja. Publicado por padrão.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/seo-gravar)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "PUT", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"titulo\": \"Tênis Adidas Forum Low Branco\",\n \"descricao\": \"Clássico do basquete dos anos 80, em couro branco. Calça normal.\",\n \"publicar\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loja-hub/seo/produtos/:sku", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "seo", "produtos", ":sku" ], "variable": [ { "key": "sku", "value": "320", "description": "O SKU do produto." } ] }, "description": "Grava o texto próprio do produto nesta loja. Publicado por padrão.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/seo-gravar)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"sku\": \"320\",\n \"endereco\": \"tenis-adidas-forum-low-branco-320\",\n \"titulo\": \"Tênis Adidas Forum Low Branco\",\n \"descricao\": \"Clássico do basquete dos anos 80, em couro branco. Calça normal.\",\n \"texto\": \"O Forum Low nasceu nas quadras e virou peça de rua. Cabedal em couro, tira no tornozelo e solado de borracha.\",\n \"palavrasChave\": [\n \"adidas forum low\",\n \"tênis branco masculino\"\n ],\n \"origem\": \"MANUAL\",\n \"publicado\": true,\n \"publicadoEm\": \"2026-09-20T11:00:00-03:00\",\n \"atualizadoEm\": \"2026-09-20T11:00:00-03:00\"\n}" } ] }, { "name": "Remover texto do produto", "request": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/seo/produtos/:sku", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "seo", "produtos", ":sku" ], "variable": [ { "key": "sku", "value": "320", "description": "O SKU do produto." } ] }, "description": "Apaga o texto próprio: a página do produto volta a ficar fora do Google.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/seo-remover)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "DELETE", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/loja-hub/seo/produtos/:sku", "host": [ "{{baseUrl}}" ], "path": [ "loja-hub", "seo", "produtos", ":sku" ], "variable": [ { "key": "sku", "value": "320", "description": "O SKU do produto." } ] }, "description": "Apaga o texto próprio: a página do produto volta a ficar fora do Google.\n\n**Permissão:** `loja-hub:escrever`\n\n[Documentação](https://docs.otlshoes.com.br/referencia/loja-hub/seo-remover)" }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "body": "" } ] } ] }, { "name": "Simuladores (sandbox)", "description": "Rotas que simulam as ações da equipe OTL (pagar, validar, despachar, lançar crédito). Só existem no ambiente de testes: selecione o ambiente **Sandbox** antes de usar.", "item": [ { "name": "Simular status do pedido", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"PAGO\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sandbox/pedidos/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "pedidos", ":id", "status" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." } ] }, "description": "A OTL confirmou o pagamento, separou, enviou, entregou ou cancelou. Dispara pedido.status_alterado.\n\n**Permissão:** qualquer token válido\n\n⚠️ **Só existe no ambiente Sandbox.** Com o ambiente Produção selecionado, responde 404.\n\n[Documentação](https://docs.otlshoes.com.br/simuladores#status-do-pedido)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"PAGO\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sandbox/pedidos/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "pedidos", ":id", "status" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." } ] }, "description": "A OTL confirmou o pagamento, separou, enviou, entregou ou cancelou. Dispara pedido.status_alterado.\n\n**Permissão:** qualquer token válido\n\n⚠️ **Só existe no ambiente Sandbox.** Com o ambiente Produção selecionado, responde 404.\n\n[Documentação](https://docs.otlshoes.com.br/simuladores#status-do-pedido)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg8k1p2a0007\",\n \"numero\": 12,\n \"status\": \"ENVIADO\",\n \"total\": \"279.80\",\n \"origem\": \"API\",\n \"referenciaExterna\": \"PED-778\",\n \"enviarPara\": \"CLIENTE\",\n \"clienteId\": \"cmg7h2k9x0003\",\n \"destinatario\": {\n \"nome\": \"Maria da Silva\",\n \"telefone\": \"5551999990000\",\n \"endereco\": {\n \"cep\": \"90000000\",\n \"rua\": \"Rua das Flores\",\n \"numero\": \"10\",\n \"complemento\": \"ap 2\",\n \"bairro\": \"Centro\",\n \"cidade\": \"Porto Alegre\",\n \"uf\": \"RS\"\n }\n },\n \"observacao\": \"Entregar à tarde\",\n \"itens\": [\n {\n \"id\": \"cmg8k1p2a0008\",\n \"sku\": \"320\",\n \"titulo\": \"Tênis Adidas Forum Low Branco\",\n \"imagem\": \"https://cdn.otlshoes.com.br/otl-catalog/320.webp\",\n \"numeracao\": \"38\",\n \"skuVariacao\": \"320U\",\n \"quantidade\": 2,\n \"precoAtacado\": \"139.90\",\n \"total\": \"279.80\",\n \"valorVenda\": \"259.90\",\n \"valorVendaEm\": \"2026-09-21T09:00:00-03:00\"\n }\n ],\n \"resultado\": {\n \"faturamento\": \"519.80\",\n \"custo\": \"279.80\",\n \"despesas\": \"10.00\",\n \"lucroBruto\": \"240.00\",\n \"lucro\": \"230.00\",\n \"margemPercentual\": 44.25,\n \"itens\": 2,\n \"itensSemVenda\": 0\n },\n \"criadoEm\": \"2026-09-20T09:15:00-03:00\",\n \"atualizadoEm\": \"2026-09-22T14:03:00-03:00\",\n \"despesas\": [\n {\n \"id\": \"cmg8m3d1e0002\",\n \"descricao\": \"Embalagem\",\n \"valor\": \"10.00\",\n \"criadoEm\": \"2026-09-21T09:05:00-03:00\"\n }\n ],\n \"rastreios\": [\n {\n \"id\": \"cmg8n9q4t0001\",\n \"codigo\": \"AA123456789BR\",\n \"transportadora\": \"Correios\",\n \"validado\": true,\n \"cadastradoPeloParceiro\": false,\n \"criadoEm\": \"2026-09-22T14:03:00-03:00\"\n }\n ],\n \"anexos\": [\n {\n \"id\": \"cmg8k5z7u0004\",\n \"tipo\": \"COMPROVANTE\",\n \"nomeArquivo\": \"comprovante-pix.pdf\",\n \"tipoArquivo\": \"application/pdf\",\n \"tamanhoBytes\": 51234,\n \"validado\": true,\n \"enviadoPeloParceiro\": true,\n \"criadoEm\": \"2026-09-20T09:20:00-03:00\"\n }\n ]\n}" } ] }, { "name": "Simular validação do comprovante", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sandbox/pedidos/:id/anexos/:anexoId/validar", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "pedidos", ":id", "anexos", ":anexoId", "validar" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "anexoId", "value": "cmg8k5z7u0004", "description": "O id do anexo." } ] }, "description": "A OTL conferiu o comprovante de pagamento. Dispara pedido.comprovante_validado.\n\n**Permissão:** qualquer token válido\n\n⚠️ **Só existe no ambiente Sandbox.** Com o ambiente Produção selecionado, responde 404.\n\n[Documentação](https://docs.otlshoes.com.br/simuladores#validar-comprovante)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sandbox/pedidos/:id/anexos/:anexoId/validar", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "pedidos", ":id", "anexos", ":anexoId", "validar" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "anexoId", "value": "cmg8k5z7u0004", "description": "O id do anexo." } ] }, "description": "A OTL conferiu o comprovante de pagamento. Dispara pedido.comprovante_validado.\n\n**Permissão:** qualquer token válido\n\n⚠️ **Só existe no ambiente Sandbox.** Com o ambiente Produção selecionado, responde 404.\n\n[Documentação](https://docs.otlshoes.com.br/simuladores#validar-comprovante)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg8k5z7u0004\",\n \"tipo\": \"COMPROVANTE\",\n \"nomeArquivo\": \"comprovante-pix.pdf\",\n \"tipoArquivo\": \"application/pdf\",\n \"tamanhoBytes\": 51234,\n \"validado\": true,\n \"enviadoPeloParceiro\": true,\n \"criadoEm\": \"2026-09-20T09:20:00-03:00\"\n}" } ] }, { "name": "Simular validação do rastreio", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sandbox/pedidos/:id/rastreios/:rastreioId/validar", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "pedidos", ":id", "rastreios", ":rastreioId", "validar" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "rastreioId", "value": "cmg8n9q4t0001", "description": "O id do rastreio." } ] }, "description": "A OTL conferiu o código de rastreio.\n\n**Permissão:** qualquer token válido\n\n⚠️ **Só existe no ambiente Sandbox.** Com o ambiente Produção selecionado, responde 404.\n\n[Documentação](https://docs.otlshoes.com.br/simuladores#validar-rastreio)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sandbox/pedidos/:id/rastreios/:rastreioId/validar", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "pedidos", ":id", "rastreios", ":rastreioId", "validar" ], "variable": [ { "key": "id", "value": "cmg8k1p2a0007", "description": "O identificador do pedido." }, { "key": "rastreioId", "value": "cmg8n9q4t0001", "description": "O id do rastreio." } ] }, "description": "A OTL conferiu o código de rastreio.\n\n**Permissão:** qualquer token válido\n\n⚠️ **Só existe no ambiente Sandbox.** Com o ambiente Produção selecionado, responde 404.\n\n[Documentação](https://docs.otlshoes.com.br/simuladores#validar-rastreio)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg8n9q4t0001\",\n \"codigo\": \"AA123456789BR\",\n \"transportadora\": \"Correios\",\n \"validado\": true,\n \"cadastradoPeloParceiro\": true,\n \"criadoEm\": \"2026-09-22T14:03:00-03:00\"\n}" } ] }, { "name": "Simular status da etiqueta", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"DESPACHADA\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sandbox/etiquetas/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "etiquetas", ":id", "status" ], "variable": [ { "key": "id", "value": "cmg8p2r5v0003", "description": "O id da etiqueta." } ] }, "description": "A OTL imprimiu a etiqueta ou despachou a caixa. Dispara etiqueta.status_alterado.\n\n**Permissão:** qualquer token válido\n\n⚠️ **Só existe no ambiente Sandbox.** Com o ambiente Produção selecionado, responde 404.\n\n[Documentação](https://docs.otlshoes.com.br/simuladores#status-da-etiqueta)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"DESPACHADA\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sandbox/etiquetas/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "etiquetas", ":id", "status" ], "variable": [ { "key": "id", "value": "cmg8p2r5v0003", "description": "O id da etiqueta." } ] }, "description": "A OTL imprimiu a etiqueta ou despachou a caixa. Dispara etiqueta.status_alterado.\n\n**Permissão:** qualquer token válido\n\n⚠️ **Só existe no ambiente Sandbox.** Com o ambiente Produção selecionado, responde 404.\n\n[Documentação](https://docs.otlshoes.com.br/simuladores#status-da-etiqueta)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg8p2r5v0003\",\n \"pedido\": {\n \"id\": \"cmg8k1p2a0007\",\n \"numero\": 12\n },\n \"servico\": {\n \"id\": 1,\n \"nome\": \"PAC\"\n },\n \"transportadora\": \"PAC\",\n \"valor\": \"23.72\",\n \"status\": \"DESPACHADA\",\n \"rastreio\": \"AA123456789BR\",\n \"emitidaEm\": \"2026-09-21T11:00:00-03:00\",\n \"impressaEm\": null,\n \"despachadaEm\": null,\n \"canceladaEm\": null,\n \"atualizadoEm\": \"2026-09-21T11:00:00-03:00\"\n}" } ] }, { "name": "Simular lançamento no saldo", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"valor\": \"139.90\",\n \"descricao\": \"Devolução do pedido #12\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sandbox/financeiro/lancamentos", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "financeiro", "lancamentos" ] }, "description": "A OTL lançou um crédito (valor positivo) ou débito (negativo). Dispara financeiro.lancamento_criado.\n\n**Permissão:** qualquer token válido\n\n⚠️ **Só existe no ambiente Sandbox.** Com o ambiente Produção selecionado, responde 404.\n\n[Documentação](https://docs.otlshoes.com.br/simuladores#lançamento-no-saldo)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"valor\": \"139.90\",\n \"descricao\": \"Devolução do pedido #12\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sandbox/financeiro/lancamentos", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "financeiro", "lancamentos" ] }, "description": "A OTL lançou um crédito (valor positivo) ou débito (negativo). Dispara financeiro.lancamento_criado.\n\n**Permissão:** qualquer token válido\n\n⚠️ **Só existe no ambiente Sandbox.** Com o ambiente Produção selecionado, responde 404.\n\n[Documentação](https://docs.otlshoes.com.br/simuladores#lançamento-no-saldo)" }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"id\": \"cmg9a2b3c0001\",\n \"tipo\": \"CREDITO\",\n \"valor\": \"150.00\",\n \"descricao\": \"Devolução do pedido #12\",\n \"pedido\": {\n \"id\": \"cmg8k1p2a0007\",\n \"numero\": 12\n },\n \"criadoEm\": \"2026-09-25T09:00:00-03:00\"\n}" } ] }, { "name": "Simular estoque", "request": { "method": "PUT", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"numeracao\": \"38\",\n \"estoque\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sandbox/produtos/:sku/estoque", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "produtos", ":sku", "estoque" ], "variable": [ { "key": "sku", "value": "320", "description": "O SKU do produto." } ] }, "description": "Muda o estoque de uma numeração no catálogo de teste. Dispara produto.estoque_atualizado.\n\n**Permissão:** qualquer token válido\n\n⚠️ **Só existe no ambiente Sandbox.** Com o ambiente Produção selecionado, responde 404.\n\n[Documentação](https://docs.otlshoes.com.br/simuladores#estoque-de-uma-numeração)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "PUT", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"numeracao\": \"38\",\n \"estoque\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sandbox/produtos/:sku/estoque", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "produtos", ":sku", "estoque" ], "variable": [ { "key": "sku", "value": "320", "description": "O SKU do produto." } ] }, "description": "Muda o estoque de uma numeração no catálogo de teste. Dispara produto.estoque_atualizado.\n\n**Permissão:** qualquer token válido\n\n⚠️ **Só existe no ambiente Sandbox.** Com o ambiente Produção selecionado, responde 404.\n\n[Documentação](https://docs.otlshoes.com.br/simuladores#estoque-de-uma-numeração)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "body": "{\n \"sku\": \"320\",\n \"ativo\": true,\n \"numeracoes\": [\n {\n \"numeracao\": \"38\",\n \"skuVariacao\": \"320U\",\n \"estoque\": 4\n },\n {\n \"numeracao\": \"39\",\n \"skuVariacao\": \"320V\",\n \"estoque\": 0\n },\n {\n \"numeracao\": \"40\",\n \"skuVariacao\": \"320W\",\n \"estoque\": 7\n }\n ],\n \"atualizadoEm\": \"2026-09-29T10:12:00-03:00\"\n}" } ] }, { "name": "Resetar a conta de teste", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sandbox/conta/resetar", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "conta", "resetar" ] }, "description": "Apaga pedidos, clientes, lançamentos e carrinho da conta de teste. Integrações e webhooks ficam.\n\n**Permissão:** qualquer token válido\n\n⚠️ **Só existe no ambiente Sandbox.** Com o ambiente Produção selecionado, responde 404.\n\n[Documentação](https://docs.otlshoes.com.br/simuladores#resetar-a-conta)" }, "response": [ { "name": "Exemplo de resposta", "originalRequest": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "O token da sua integração (variável do ambiente)." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sandbox/conta/resetar", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "conta", "resetar" ] }, "description": "Apaga pedidos, clientes, lançamentos e carrinho da conta de teste. Integrações e webhooks ficam.\n\n**Permissão:** qualquer token válido\n\n⚠️ **Só existe no ambiente Sandbox.** Com o ambiente Produção selecionado, responde 404.\n\n[Documentação](https://docs.otlshoes.com.br/simuladores#resetar-a-conta)" }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "body": "" } ] } ] } ] }