POST

api/comercial/fa/Pedido/Efetivar

Informações de Envio:

Cabeçalhos de Envio:

Parâmetro Valor Descrição Tipo de parâmetro Tipo de dados
Authorization Bearer Hash gerado no login Header String

Acesse o método de login para mais informações: api/genericos/ge/Login/Autenticar

Modelo:

EfetivacaoDTO

NomeDescriçãoTipoInformação Adicional
Efetivacao

string

Opcional
Serie

string

Opcional
Transportadora

string

Opcional
TipoFrete

string

Opcional
Placa

string

Opcional
UF

string

Opcional
Marca

string

Opcional
Volume

decimal number

Opcional
Quantidade

decimal number

Opcional
Especie

string

Opcional
DataSaida

date

Opcional
HoraSaida

string

Opcional
UnidadeNegocio

string

Opcional
Pedido

EfetivacaoPedidoDTO

Opcional

Formato de Envio:

application/json, text/json

Exemplo: 
{
  "Efetivacao": "string 1",
  "Serie": "string 2",
  "Transportadora": "string 3",
  "TipoFrete": "string 4",
  "Placa": "string 5",
  "UF": "string 6",
  "Marca": "string 7",
  "Volume": 8.0,
  "Quantidade": 9.0,
  "Especie": "string 10",
  "DataSaida": "2026-01-13",
  "HoraSaida": "string 12",
  "UnidadeNegocio": "string 13",
  "Pedido": {
    "Codigo": "string 1",
    "Itens": [
      {
        "SequenciaItem": 1,
        "Quantidade": 2.0
      }
    ]
  }
}

Informações de Retorno:

Cabeçalhos Adicionais:

Nome Descrição Valor
cigam-api-version Versão do build/compilação dessa versão da API 2.1.8565.21067

Modelo:

HttpCustomResponse

NomeDescriçãoTipoInformação Adicional
success

boolean

Opcional
hash

string

Opcional
messages

string

Opcional
data

Object

Opcional
tipoLogin

string

Opcional

Formato de Resposta:

Código de status HTTP Descrição Modelo de resposta
200 OK

application/json, text/json

Exemplo: 
{
  "success": true,
  "hash": "string 2",
  "messages": [
    "string 1"
  ],
  "data": {},
  "tipoLogin": "string 4"
}
400 Requisição inválida

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
401 Não autorizado

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
500 Requisição falhou

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
502 Falha de comunicação

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}