Remover cliente

Tira um cliente da agenda do parceiro.

DELETE/v1/clientes/{id}

Parâmetros

Parâmetro	Tipo	Padrão	Descrição
`id` obrigatório	texto	—	O identificador do cliente, no caminho.

Exemplo

curl -X DELETE "https://api.otlshoes.com.br/v1/clientes/cmg7h2k9x0003" \
  -H "Authorization: Bearer otl_prod_SEU_TOKEN"

curl -X DELETE "https://api-sandbox.otlshoes.com.br/v1/clientes/cmg7h2k9x0003" \
  -H "Authorization: Bearer otl_sbx_SEU_TOKEN"

const resposta = await fetch('https://api.otlshoes.com.br/v1/clientes/cmg7h2k9x0003', {
  method: 'DELETE',
  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/clientes/cmg7h2k9x0003', {
  method: 'DELETE',
  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/clientes/cmg7h2k9x0003');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
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/clientes/cmg7h2k9x0003');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
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.delete(
    "https://api.otlshoes.com.br/v1/clientes/cmg7h2k9x0003",
    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.delete(
    "https://api-sandbox.otlshoes.com.br/v1/clientes/cmg7h2k9x0003",
    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 testeDELETE

Resposta

204 No Content, sem corpo.

Regras que não se leem no JSON

Os pedidos já feitos para este cliente continuam intactos, com o endereço que tinham: o pedido guarda uma cópia do destinatário.
Remover de novo um cliente já removido responde 404.

Não dá para desfazer

A remoção é definitiva. Para “desfazer”, crie o cliente de novo — ele terá outro id.

Erros possíveis

HTTP	`codigo`	Quando
404	`NAO_ENCONTRADO`	O cliente não existe, ou é de outro parceiro
403	`ESCOPO_INSUFICIENTE`	A integração não tem `clientes:escrever`