Lançar despesa

Registra um custo que o parceiro teve no pedido — frete, embalagem, taxa.

POST/v1/pedidos/{id}/despesas

Quando usar

Para o resultado do pedido refletir o lucro de verdade do parceiro: o frete que ele pagou, a embalagem, a comissão do marketplace.

As despesas são do parceiro

A OTL não usa nem enxerga as despesas lançadas. Elas existem só para a conta do parceiro.

Corpo

Parâmetro	Tipo	Padrão	Descrição
`id` obrigatório	texto	—	O identificador do pedido, no caminho.
`descricao` obrigatório	texto	—	Até 120 caracteres.
`valor` obrigatório	dinheiro	—	Positivo, com até 2 casas. Zero é aceito.

Exemplo

curl -X POST "https://api.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007/despesas" \
  -H "Authorization: Bearer otl_prod_SEU_TOKEN" \
  -H "Idempotency-Key: 7f3c1b9e-pedido-ml-123" \
  -H "Content-Type: application/json" \
  -d '{
  "descricao": "Embalagem",
  "valor": "10.00"
}'

curl -X POST "https://api-sandbox.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007/despesas" \
  -H "Authorization: Bearer otl_sbx_SEU_TOKEN" \
  -H "Idempotency-Key: 7f3c1b9e-pedido-ml-123" \
  -H "Content-Type: application/json" \
  -d '{
  "descricao": "Embalagem",
  "valor": "10.00"
}'

const resposta = await fetch('https://api.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007/despesas', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer otl_prod_SEU_TOKEN',
    'Idempotency-Key': '7f3c1b9e-pedido-ml-123',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "descricao": "Embalagem",
    "valor": "10.00"
  }),
});

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/despesas', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer otl_sbx_SEU_TOKEN',
    'Idempotency-Key': '7f3c1b9e-pedido-ml-123',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "descricao": "Embalagem",
    "valor": "10.00"
  }),
});

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/despesas');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer otl_prod_SEU_TOKEN',
    'Idempotency-Key: 7f3c1b9e-pedido-ml-123',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'descricao' => 'Embalagem',
    'valor' => '10.00',
]));

$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/despesas');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer otl_sbx_SEU_TOKEN',
    'Idempotency-Key: 7f3c1b9e-pedido-ml-123',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'descricao' => 'Embalagem',
    'valor' => '10.00',
]));

$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.post(
    "https://api.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007/despesas",
    headers={
        "Authorization": "Bearer otl_prod_SEU_TOKEN",
        "Idempotency-Key": "7f3c1b9e-pedido-ml-123",
    },
    json={
        "descricao": "Embalagem",
        "valor": "10.00"
    },
    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.post(
    "https://api-sandbox.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007/despesas",
    headers={
        "Authorization": "Bearer otl_sbx_SEU_TOKEN",
        "Idempotency-Key": "7f3c1b9e-pedido-ml-123",
    },
    json={
        "descricao": "Embalagem",
        "valor": "10.00"
    },
    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 testePOSTIdempotency-KeyCorpo (JSON)

Resposta

201 Created, com a despesa criada:

{
  "id": "cmg8m3d1e0002",
  "descricao": "Embalagem",
  "valor": "10.00",
  "criadoEm": "2026-09-21T09:05:00-03:00"
}

Regras que não se leem no JSON

A despesa é do pedido, não de um item.
Entra em resultado.despesas e é descontada de resultado.lucro na próxima leitura do pedido.
Não há edição: remova e lance de novo.
Para não lançar duas vezes numa nova tentativa, envie Idempotency-Key.

Erros possíveis

HTTP	`codigo`	Quando
400	`VALIDACAO`	`descricao` ou `valor` ausente ou inválido
404	`NAO_ENCONTRADO`	O pedido não existe — ou é de outro parceiro
403	`ESCOPO_INSUFICIENTE`	A integração não tem `pedidos:escrever`

Ver também

Remover despesa