Conta

Os dados da loja do parceiro e o endereço de remetente. Somente leitura.

GET/v1/conta

Quando usar

Para preencher o nome da loja ou o remetente em documentos do seu sistema.
Para saber, antes de tentar criar um pedido, se a ficha do parceiro está completa.

A ficha não é editável pela API. Ela é preenchida pelo parceiro no painel, em Minha conta.

Requisição

Sem parâmetros.

curl "https://api.otlshoes.com.br/v1/conta" \
  -H "Authorization: Bearer otl_prod_SEU_TOKEN"

curl "https://api-sandbox.otlshoes.com.br/v1/conta" \
  -H "Authorization: Bearer otl_sbx_SEU_TOKEN"

const resposta = await fetch('https://api.otlshoes.com.br/v1/conta', {
  headers: {
    Authorization: 'Bearer otl_prod_SEU_TOKEN',
  },
});

if (!resposta.ok) {
  const { erro } = await resposta.json();
  throw new Error(`${erro.codigo}: ${erro.mensagem} (${erro.requestId})`);
}
const dados = await resposta.json();

const resposta = await fetch('https://api-sandbox.otlshoes.com.br/v1/conta', {
  headers: {
    Authorization: 'Bearer otl_sbx_SEU_TOKEN',
  },
});

if (!resposta.ok) {
  const { erro } = await resposta.json();
  throw new Error(`${erro.codigo}: ${erro.mensagem} (${erro.requestId})`);
}
const dados = await resposta.json();

<?php
$ch = curl_init('https://api.otlshoes.com.br/v1/conta');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer otl_prod_SEU_TOKEN',
]);

$corpo = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new Exception($corpo['erro']['codigo'] . ': ' . $corpo['erro']['mensagem']);
}

<?php
$ch = curl_init('https://api-sandbox.otlshoes.com.br/v1/conta');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer otl_sbx_SEU_TOKEN',
]);

$corpo = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new Exception($corpo['erro']['codigo'] . ': ' . $corpo['erro']['mensagem']);
}

import requests

resposta = requests.get(
    "https://api.otlshoes.com.br/v1/conta",
    headers={
        "Authorization": "Bearer otl_prod_SEU_TOKEN",
    },
    timeout=30,
)

if not resposta.ok:
    erro = resposta.json()["erro"]
    raise RuntimeError(f'{erro["codigo"]}: {erro["mensagem"]} ({erro["requestId"]})')
dados = resposta.json()

import requests

resposta = requests.get(
    "https://api-sandbox.otlshoes.com.br/v1/conta",
    headers={
        "Authorization": "Bearer otl_sbx_SEU_TOKEN",
    },
    timeout=30,
)

if not resposta.ok:
    erro = resposta.json()["erro"]
    raise RuntimeError(f'{erro["codigo"]}: {erro["mensagem"]} ({erro["requestId"]})')
dados = resposta.json()

Testar agora no ambiente de testes

A chamada é feita de verdade, do seu navegador para a API de testes (https://api-sandbox.otlshoes.com.br/v1). Use um token otl_sbx_…: ele fica só nesta aba, e some ao fechá-la. Token de produção não é aceito aqui.

Token de testeGET

Resposta

{
  "nome": "Loja do João",
  "loja": {
    "nome": "João Calçados",
    "telefone": "5551988887777",
    "site": "https://joaocalcados.com.br"
  },
  "remetente": {
    "nome": "João Calçados",
    "cep": "91000-000",
    "rua": "Av. Brasil",
    "numero": "500",
    "complemento": "Sala 2",
    "bairro": "Centro",
    "cidade": "Canoas",
    "uf": "RS",
    "origem": "loja"
  },
  "links": [
    {
      "plataforma": "SHOPEE",
      "rotulo": null,
      "url": "https://shopee.com.br/joaocalcados"
    },
    {
      "plataforma": "OUTRO",
      "rotulo": "Enjoei",
      "url": "https://enjoei.com.br/joaocalcados"
    }
  ],
  "fichaCompleta": true
}

Campo	Tipo	Descrição
`nome`	texto	Nome da conta do parceiro.
`loja.nome`	texto ou null	Nome da loja.
`loja.telefone`	texto ou null	Contato da loja, só dígitos, com DDI: `55` + DDD + número.
`loja.site`	texto ou null	Site da loja.
`remetente`	objeto ou null	Endereço usado como remetente das etiquetas. `null` quando a ficha ainda não tem endereço utilizável.
`remetente.origem`	texto	`loja` quando o endereço da loja está completo; senão `pessoal`, o endereço do parceiro.
`remetente.cep`	texto	CEP como foi cadastrado, com ou sem hífen.
`remetente.uf`	texto ou null	Sigla do estado, com duas letras.
`links`	lista	Onde o parceiro vende. `plataforma` é um código fixo (veja abaixo).
`links[].rotulo`	texto ou null	Só vem preenchido quando `plataforma` é `OUTRO`.
`fichaCompleta`	booleano	Se o parceiro preencheu o mínimo para fechar pedidos: nome, telefone e endereço.

Valores de links[].plataforma: INSTAGRAM, FACEBOOK, TIKTOK, SHOPEE, MERCADO_LIVRE, MAGALU, SITE_PROPRIO e OUTRO. Em Instagram, Facebook e TikTok, url pode ser um @perfil em vez de um link.

Sem CPF nem CNPJ

A resposta não traz documentos do parceiro. Nenhuma rota da API precisa deles.

Erros possíveis

HTTP	`codigo`	Quando
403	`ESCOPO_INSUFICIENTE`	A integração não tem `conta:ler`

Mais os de autenticação — veja Usando o token.