Cadastra uma filial pela API do TMS

POST/integracao/v1/filiais

Mesma implementação do cadastro pelo portal. A siglaExterna é o identificador que o manifesto usa para referenciar a filial; é única por transportadora (repetida = 409). Pela API do TMS o endereço NÃO é geocodificado (limite de taxa do serviço externo): sem latitude/longitude, a filial fica sem pino até o ajuste no portal. Exige API key de PRODUCAO: enquanto os cadastros não separam dados por ambiente, a chave de TESTE só lê (gravar = 403).

Para que serve: cadastra uma filial.

Quando chamar: uma vez por filial, antes do primeiro manifesto de transferência. Para poucas filiais, é mais simples cadastrar no portal.

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

201application/json

Filial criada

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`	`nome` ou `siglaExterna` em branco ou longos demais, ou raio fora de 10 a 50000	Corrigir o campo indicado em `detail`
`401`	Chave inválida	Conferir a chave
`403`	Chave de teste (ela só lê cadastros) ou chave que não é de TMS	Usar a chave de produção
`409`	Já existe filial com essa `siglaExterna` (`detail`: "já existe filial com a sigla externa CPS")	Usar o `PUT` para alterar

Observações

Sem Idempotency-Key. Repetir o POST com a mesma sigla devolve 409, o que protege contra duplicata.
A API não localiza o endereço no mapa. Sem latitude e longitude, a filial fica sem pino até alguém ajustar no portal. Se você já tem as coordenadas, mande.

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

Requisição

Produção

https://api.veltrasolution.com

Teste

https://api-teste.veltrasolution.com

curl -X POST 'https://api.veltrasolution.com/integracao/v1/filiais' \
  -H 'X-Veltra-Api-Key: SUA_CHAVE_AQUI' \
  -H 'Content-Type: application/json'

const resposta = await fetch("https://api.veltrasolution.com/integracao/v1/filiais", {
  method: "POST",
  headers: {
    "X-Veltra-Api-Key": "SUA_CHAVE_AQUI",
    "Content-Type": "application/json",
  },
});

console.log(resposta.status);
console.log(await resposta.text());

import requests

resposta = requests.request(
    "POST",
    "https://api.veltrasolution.com/integracao/v1/filiais",
    headers={
        "X-Veltra-Api-Key": "SUA_CHAVE_AQUI",
        "Content-Type": "application/json",
    },
    timeout=30,
)

print(resposta.status_code)
print(resposta.text)

<?php
$ch = curl_init('https://api.veltrasolution.com/integracao/v1/filiais');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'X-Veltra-Api-Key: SUA_CHAVE_AQUI',
        'Content-Type: application/json',
    ],
]);

$resposta = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
echo $resposta;
curl_close($ch);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Exemplo {
    public static void main(String[] args) throws Exception {
        HttpRequest requisicao = HttpRequest.newBuilder(URI.create("https://api.veltrasolution.com/integracao/v1/filiais"))
        .header("X-Veltra-Api-Key", "SUA_CHAVE_AQUI")
        .header("Content-Type", "application/json")
        .method("POST", HttpRequest.BodyPublishers.noBody())
        .build();

        HttpResponse<String> resposta = HttpClient.newHttpClient()
            .send(requisicao, HttpResponse.BodyHandlers.ofString());

        System.out.println(resposta.statusCode());
        System.out.println(resposta.body());
    }
}

using System.Net.Http;
using System.Text;

using var cliente = new HttpClient();
var requisicao = new HttpRequestMessage(new HttpMethod("POST"), "https://api.veltrasolution.com/integracao/v1/filiais");
requisicao.Headers.Add("X-Veltra-Api-Key", "SUA_CHAVE_AQUI");

var resposta = await cliente.SendAsync(requisicao);
Console.WriteLine((int)resposta.StatusCode);
Console.WriteLine(await resposta.Content.ReadAsStringAsync());

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	requisicao, err := http.NewRequest("POST", "https://api.veltrasolution.com/integracao/v1/filiais", nil)
	if err != nil {
		panic(err)
	}
	requisicao.Header.Set("X-Veltra-Api-Key", "SUA_CHAVE_AQUI")
	requisicao.Header.Set("Content-Type", "application/json")

	resposta, err := http.DefaultClient.Do(requisicao)
	if err != nil {
		panic(err)
	}
	defer resposta.Body.Close()

	texto, _ := io.ReadAll(resposta.Body)
	fmt.Println(resposta.StatusCode)
	fmt.Println(string(texto))
}

Troque SUA_CHAVE_AQUI pela sua chave. O servidor de teste tem o mesmo comportamento do de produção.