Remover comprovante

Apaga um comprovante enviado pelo parceiro e ainda não validado.

DELETE/v1/pedidos/{id}/anexos/{anexoId}

Parâmetros

Parâmetro	Tipo	Padrão	Descrição
`id` obrigatório	texto	—	O identificador do pedido, no caminho.
`anexoId` obrigatório	texto	—	O `id` do anexo (`anexos[].id` do pedido), no caminho.

Exemplo

curl -X DELETE "https://api.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007/anexos/cmg8k5z7u0004" \
  -H "Authorization: Bearer otl_prod_SEU_TOKEN"

curl -X DELETE "https://api-sandbox.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007/anexos/cmg8k5z7u0004" \
  -H "Authorization: Bearer otl_sbx_SEU_TOKEN"

const resposta = await fetch('https://api.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007/anexos/cmg8k5z7u0004', {
  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/pedidos/cmg8k1p2a0007/anexos/cmg8k5z7u0004', {
  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/pedidos/cmg8k1p2a0007/anexos/cmg8k5z7u0004');
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/pedidos/cmg8k1p2a0007/anexos/cmg8k5z7u0004');
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/pedidos/cmg8k1p2a0007/anexos/cmg8k5z7u0004",
    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/pedidos/cmg8k1p2a0007/anexos/cmg8k5z7u0004",
    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

Só dá para remover um anexo com tipo: "COMPROVANTE", enviadoPeloParceiro: true e validado: false:

documento anexado pela OTL (etiqueta, nota fiscal) não é removido pela API;
comprovante já validado é o registro do pagamento aceito, e fica travado.

Não dá para desfazer

O arquivo é apagado de vez. Para corrigir um comprovante errado, remova e envie o certo.

Erros possíveis

HTTP	`codigo`	Quando
403	`ACESSO_NEGADO`	O anexo é da OTL, ou o comprovante já foi validado
404	`NAO_ENCONTRADO`	O pedido ou o anexo não existe
403	`ESCOPO_INSUFICIENTE`	A integração não tem `pedidos:escrever`