Sign in

v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB
Logística

Incluir uma nova Ordem de Carga

Permite incluir uma nova Ordem de Carga no ERP.

post/v1/logistica/ordens-carga

Request body

codigoOrdemCargainteger

Código de identificação da Ordem de Carga.

codigoEmpresainteger required

Código da empresa da ordem de carga.

codigoRoteirizadorstring

Id da rota planejada na ferramenta de roteirização.

nomeEmpresastring

Nome da empresa da ordem de carga.

dataIniciostring

Data de início da operação.

dataPrevistaSaidastring

Data prevista para a saída do veículo.

horaSaidastring

Hora prevista para a saída.

codigoVeiculointeger

Código do veículo alocado para a carga.

codigoRegiaointeger

Código da região de destino da ordem de carga.

nomeRegiaostring

Nome da região de destino.

codigoTransportadorainteger

Código do parceiro Transportadora.

nomeTransportadorastring

Nome da transportadora.

codigoMotoristainteger

Código do parceiro Motorista.

nomeMotoristastring

Nome do motorista.

roteirostring

Descrição detalhada do roteiro a ser seguido.

tipo1 | 2 | 3 required

Define o tipo da Ordem de Carga. 1: Ambos, 2: Entrada, 3: Saída.

situacao1 | 2 required

Situação atual da Ordem de Carga. 1: Aberta, 2: Fechada.

pesoMaximonumber float

Peso máximo suportado pela carga em Kg.

metroCubicoMaximonumber float

Volume máximo suportado pela carga em m³.

observacoesstring

Observações gerais sobre a ordem de carga.

Example request

{
  "codigoOrdemCarga": 901,
  "codigoEmpresa": 1,
  "nomeEmpresa": "Empresa Matriz Ltda.",
  "dataInicio": "12/09/2025",
  "dataPrevistaSaida": "13/09/2025",
  "horaSaida": "14:30",
  "codigoVeiculo": 205,
  "codigoRegiao": 10,
  "nomeRegiao": "TRIÂNGULO MINEIRO",
  "codigoTransportadora": 432,
  "nomeTransportadora": "Transportadora Rápida S.A.",
  "codigoMotorista": 8115,
  "nomeMotorista": "José da Silva",
  "roteiro": "Seguir pela BR-050 até Uberlândia, depois BR-365...",
  "tipo": 3,
  "situacao": 1,
  "pesoMaximo": 25000.5,
  "metroCubicoMaximo": 88.7,
  "observacoes": "Carga frágil, manusear com cuidado."
}

Response

Operação bem sucedida. Retorna a Ordem de Carga criada.

Example response

{
  "ordemCarga": {
    "codigoOrdemCarga": 901,
    "codigoEmpresa": 1,
    "nomeEmpresa": "Empresa Matriz Ltda.",
    "dataInicio": "12/09/2025",
    "dataPrevistaSaida": "13/09/2025",
    "horaSaida": "14:30",
    "codigoVeiculo": 205,
    "codigoRegiao": 10,
    "nomeRegiao": "TRIÂNGULO MINEIRO",
    "codigoTransportadora": 432,
    "nomeTransportadora": "Transportadora Rápida S.A.",
    "codigoMotorista": 8115,
    "nomeMotorista": "José da Silva",
    "roteiro": "Seguir pela BR-050 até Uberlândia, depois BR-365...",
    "tipo": 3,
    "situacao": 1,
    "pesoMaximo": 25000.5,
    "metroCubicoMaximo": 88.7,
    "observacoes": "Carga frágil, manusear com cuidado."
  }
}