Manual da API · Leitura e consulta

Grava cidades e prazos pela chave do TMS

PUT/v1/saida/configuracao-prazo

O TMS envia a relação de cidades e prazos. Mesmo schema do portal. A mudança vale para as cargas que chegarem depois.

Para que serve: grava a relação de cidades, prazos e feriados. Substitui toda a configuração.

Quando chamar: na implantação, e sempre que o prazo por cidade ou os feriados mudarem no TMS. A mudança vale para as cargas que chegarem depois.

Parâmetros

Cabeçalhos (header)

X-Veltra-Api-Keytextoobrigatório
Chave de API do TMS. Emitida na tela Chaves de API do portal; o valor completo aparece uma única vez.
Content-Typetextoobrigatório
Sempre application/json.

Respostas

200application/json

Configuração gravada

403application/problem+json

CHAVE_SUSPENSA (no campo codigo): a chave de consulta está suspensa porque o add-on foi desligado. A chave não foi revogada e volta a funcionar quando o add-on for contratado de novo.

JSON

{
  "type": "https://exemplo.com.br/webhook-veltra",
  "title": "texto",
  "status": 1,
  "detail": "texto",
  "instance": "https://exemplo.com.br/webhook-veltra",
  "codigo": "ASAAS_RECUSOU"
}

Campos da resposta (6)

Campos

typetextoobrigatório
titletextoobrigatório
statusinteiroobrigatório
detailtextoopcional
instancetextoopcional
codigotextoopcional
Código estável do problema para o cliente decidir o tratamento (ex.: ASAAS_RECUSOU, FATURA_NAO_ENCONTRADA, PAGINACAO_INVALIDA). Ausente quando o erro não tem código próprio.

Erroapplication/problem+json

Erro no formato RFC 9457 (application/problem+json)

JSON

{
  "type": "https://exemplo.com.br/webhook-veltra",
  "title": "texto",
  "status": 1,
  "detail": "texto",
  "instance": "https://exemplo.com.br/webhook-veltra",
  "codigo": "ASAAS_RECUSOU"
}

Campos da resposta (6)

Campos

typetextoobrigatório
titletextoobrigatório
statusinteiroobrigatório
detailtextoopcional
instancetextoopcional
codigotextoopcional
Código estável do problema para o cliente decidir o tratamento (ex.: ASAAS_RECUSOU, FATURA_NAO_ENCONTRADA, PAGINACAO_INVALIDA). Ausente quando o erro não tem código próprio.

Guia explicado

O que fazer: erros

Status	Quando	O que fazer
`400`	`prazoPadraoHoras` fora de 1 a 720; `cidades` ou `feriadosLocais` ausentes; cidade, UF ou horas inválidas; cidade repetida; feriado inválido; data de feriado repetida	Corrigir o corpo
`401`	Chave inválida	Conferir a chave
`403`	Chave que não é de TMS	Usar a chave de TMS
`429`	Limite de chamadas	Esperar o `Retry-After`

Observações

É uma substituição completa. As cidades e os feriados que você não mandar são apagados. Leia com o GET, altere e devolva tudo.
É seguro repetir: o mesmo corpo dá o mesmo resultado.
Configurar o prazo não substitui a conversa com a transportadora sobre calendário local e regra de prazo; combine antes de ligar em produção.
A configuração é única da transportadora e não separa teste de produção.

Texto completo, com mais exemplos, em API por rota.