Notas de Implementação:
Buscar os dados da disponibilidade de um material em estoque.
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:
Parâmetro que deve conter os requisitos para a criação da DisponibilidadeMaterialDTO
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| Origem | string |
Obrigatório |
|
| CodigoMaterial | string |
Obrigatório |
|
| Especif1 | string |
Opcional |
|
| Especif2 | string |
Opcional |
|
| Especif3 | string |
Opcional |
|
| Numeracao | string |
Opcional |
|
| CodigoUnidadeNegocio | string |
Obrigatório |
|
| CodigoCentroArmazenagem | string |
Obrigatório |
|
| QuantidadeAnterior | decimal number |
Opcional |
|
| QuantidadeAtual | decimal number |
Opcional |
|
| DesconsiderarQuantidadeAnterior | boolean |
Opcional |
|
| Pedido | string |
Opcional |
|
| SequenciaItemPedido | integer |
Opcional |
|
| Lote | string |
Opcional |
|
| AvisarBloquearQuantidadeInsuficiente | string |
Opcional |
|
| TipoPedido | string |
Opcional |
|
| CodigoUsuario | string |
Obrigatório |
|
| BatchOnline | string |
Opcional |
|
| AlterarOpcao | boolean |
Opcional |
|
| SuprimirZerados | boolean |
Opcional |
Formato de Envio:
application/json, text/json
Exemplo:
{
"Origem": "string 1",
"CodigoMaterial": "string 2",
"Especif1": "string 3",
"Especif2": "string 4",
"Especif3": "string 5",
"Numeracao": "string 6",
"CodigoUnidadeNegocio": "string 7",
"CodigoCentroArmazenagem": "string 8",
"QuantidadeAnterior": 9.1,
"QuantidadeAtual": 10.1,
"DesconsiderarQuantidadeAnterior": true,
"Pedido": "string 12",
"SequenciaItemPedido": 13,
"Lote": "string 14",
"AvisarBloquearQuantidadeInsuficiente": "string 15",
"TipoPedido": "string 16",
"CodigoUsuario": "string 17",
"BatchOnline": "string 18",
"AlterarOpcao": true,
"SuprimirZerados": true
}
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:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| OrdensGerais |
Opcional |
||
| DemandasGerais |
Opcional |
||
| EstoqueGeral |
Opcional |
||
| DisponibilidadeGeral |
Opcional |
||
| UnidadesDeNegocio | Object |
Opcional |
|
| UnidadeMedida |
Opcional |
Formato de Resposta:
Classe de Resposta (Status 200)
OK
application/json, text/json
Exemplo:
{
"OrdensGerais": [
{
"Ordem": 1,
"Tipo": "string 2",
"SequenciaCompras": 3,
"CodigoMaterial": "string 4",
"Especif1": "string 5",
"Especif2": "string 6",
"Especif3": "string 7",
"Numeracao": "string 8",
"Demanda": 9,
"QuantidadeSaldo": 10.1,
"DataProgramada": "2026-01-13",
"DataInicio": "2026-01-13",
"PercPerdaItensFilhos": 11.1,
"CodigoUnidadeNegocio": "string 12",
"OrdenadorSequencial": "string 13",
"Situacao": "string 14",
"SituacaoDescCalculado": "",
"Liberacao": "string 15",
"Atendimento": "string 16",
"AtendimentoDescCalculado": "",
"TipoDescCalculado": "",
"Material": {
"Codigo": "string 1",
"Descricao": "string 2",
"Tipo": "string 3",
"TipoDescricao": "",
"CodigoUnidadeMedida": "string 4",
"Criacao": "2026-01-13",
"Modificacao": "2026-01-13",
"CodigoGrupo": "string 5",
"CodigoSubGrupo": "string 6",
"CodigoEspecificacao1": "string 7",
"CodigoEspecificacao2": "string 8",
"CodigoEspecificacao3": "string 9",
"UtilizaGrade": "string 10",
"GarantiaVenda": 11,
"UnidadeMedida": {
"Codigo": "string 1",
"Descricao": "string 2",
"Mascara": "N8.6CA",
"Inteiro": 8,
"NumeroDecimal": 6
},
"Grupo": {
"Codigo": "string 1",
"Descricao": "string 2",
"ControleEspecificacao1": "string 3",
"ControleEspecificacao2": "string 4",
"ControleEspecificacao3": "string 5",
"NomeEspecif1": "string 6",
"NomeEspecif2": "string 7",
"NomeEspecif3": "string 8",
"NomeEspecif1Calculado": "string 6",
"NomeEspecif2Calculado": "string 7",
"NomeEspecif3Calculado": "string 8",
"SubGrupos": [
{
"Codigo": "string 1",
"CodigoGrupo": "string 2",
"Descricao": "string 3",
"Materiais": []
}
]
},
"Referencia": "string 12",
"CodigoConfigurador": "string 13",
"Aplicacao": "string 14",
"EstruturaComercial": true,
"ControlaNumeroSerie": true,
"CodigoContaGerencial": "string 17",
"Configurador": {
"Codigo": "string 1",
"Descricao": "string 2",
"Ativo": true,
"UsuarioCriacao": "string 4",
"DataCriacao": "2026-01-13",
"UsuarioModificacao": "string 5",
"DataModificacao": "2026-01-13",
"Sessao": 6,
"TipoRegra": "string 7"
},
"Complemento": {
"CodigoMaterial": "string 1",
"CodigoQuestionario": "string 2",
"Imagem": "string 3",
"CodigoGrade": "string 4"
}
}
}
],
"DemandasGerais": [
{
"Demanda": 1,
"Tipo": "string 2",
"TipoDescCalculado": "",
"SequenciaItemPedido": 3,
"CodigoMaterial": "string 4",
"Especif1": "string 5",
"Especif2": "string 6",
"Especif3": "string 7",
"Numeracao": "string 8",
"Lote": "string 9",
"QuantidadeSaldo": 10.1,
"DataProgramada": "2026-01-13",
"PercPerdaItensFilhos": 11.1,
"CodigoUnidadeNegocio": "string 12",
"Ordem": 13,
"Liberacao": "string 14",
"Material": {
"Codigo": "string 1",
"Descricao": "string 2",
"Tipo": "string 3",
"TipoDescricao": "",
"CodigoUnidadeMedida": "string 4",
"Criacao": "2026-01-13",
"Modificacao": "2026-01-13",
"CodigoGrupo": "string 5",
"CodigoSubGrupo": "string 6",
"CodigoEspecificacao1": "string 7",
"CodigoEspecificacao2": "string 8",
"CodigoEspecificacao3": "string 9",
"UtilizaGrade": "string 10",
"GarantiaVenda": 11,
"UnidadeMedida": {
"Codigo": "string 1",
"Descricao": "string 2",
"Mascara": "N8.6CA",
"Inteiro": 8,
"NumeroDecimal": 6
},
"Grupo": {
"Codigo": "string 1",
"Descricao": "string 2",
"ControleEspecificacao1": "string 3",
"ControleEspecificacao2": "string 4",
"ControleEspecificacao3": "string 5",
"NomeEspecif1": "string 6",
"NomeEspecif2": "string 7",
"NomeEspecif3": "string 8",
"NomeEspecif1Calculado": "string 6",
"NomeEspecif2Calculado": "string 7",
"NomeEspecif3Calculado": "string 8",
"SubGrupos": [
{
"Codigo": "string 1",
"CodigoGrupo": "string 2",
"Descricao": "string 3",
"Materiais": []
}
]
},
"Referencia": "string 12",
"CodigoConfigurador": "string 13",
"Aplicacao": "string 14",
"EstruturaComercial": true,
"ControlaNumeroSerie": true,
"CodigoContaGerencial": "string 17",
"Configurador": {
"Codigo": "string 1",
"Descricao": "string 2",
"Ativo": true,
"UsuarioCriacao": "string 4",
"DataCriacao": "2026-01-13",
"UsuarioModificacao": "string 5",
"DataModificacao": "2026-01-13",
"Sessao": 6,
"TipoRegra": "string 7"
},
"Complemento": {
"CodigoMaterial": "string 1",
"CodigoQuestionario": "string 2",
"Imagem": "string 3",
"CodigoGrade": "string 4"
}
}
}
],
"EstoqueGeral": [
{
"Codigo": 1,
"Campo3": "string 2",
"Campo4": "string 3",
"Campo5": "string 4",
"Campo6": "string 5",
"Campo7": "string 6",
"Campo8": "string 7",
"Campo9": "string 8",
"Campo10": "string 9",
"Campo11": "string 10",
"Campo43": "string 11",
"Campo44": "string 12",
"Campo48": "string 13",
"Campo65": "string 14",
"Campo68": "string 15",
"Campo83": 1,
"CodigoUsuario": "string 16",
"Campo133": 1.1,
"Campo134": 1.1,
"Campo135": 1.1,
"Campo136": 1.1,
"Campo155": "2026-01-13"
}
],
"DisponibilidadeGeral": [
{
"Codigo": 1,
"Campo3": "string 2",
"Campo4": "string 3",
"Campo5": "string 4",
"Campo6": "string 5",
"Campo7": "string 6",
"Campo8": "string 7",
"Campo9": "string 8",
"Campo10": "string 9",
"Campo11": "string 10",
"Campo43": "string 11",
"Campo44": "string 12",
"Campo48": "string 13",
"Campo65": "string 14",
"Campo68": "string 15",
"Campo83": 1,
"CodigoUsuario": "string 16",
"Campo133": 1.1,
"Campo134": 1.1,
"Campo135": 1.1,
"Campo136": 1.1,
"Campo155": "2026-01-13"
}
],
"UnidadesDeNegocio": [
{}
],
"UnidadeMedida": {
"Codigo": "string 1",
"Descricao": "string 2",
"Mascara": "N8.6CA",
"Inteiro": 8,
"NumeroDecimal": 6
}
}