IN CadastroPedidos.integrador

De CIGAM WIKI
Revisão de 17h34min de 30 de novembro de 2022 por Elizama.Dias (discussão | contribs)

Voltar
Integrador > WebServices > IN CadastroPedidos.integrador

Cadastrar

Esse método é utilizado para a exportação de pedido em partes separadas, visando vincular seus itens correlatos chamando o serviço de CadastroItensPedido.Integrador, indicando o parâmetro statusRegistro como pendente tanto no método de Cadastrar do serviço de Pedidos quanto no método de Cadastrar do serviço de Itens Pedido no envio das requisições.
Para que seja completa a integração deve se utilizar o método LiberarPendentes para ser integrado com o CIGAM o pedido e suas dependências.

  • Parâmetros:


Retornos:
   Se sucesso:
      idRegistro - ID que representa este registro na tabela de integração.

   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se algum parâmetro inválido:
      Parâmetro necessário não informado.

ListarId

Esse método é utilizado para importação dos códigos de pedidos já cadastrados no CIGAM.

  • Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

ListarIndividual

  • Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

ListarModificacoes

  • Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

ListarPendentes

  • Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

LiberarPendentes

  • Parâmetros:


Retornos:
   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se erro na conexão com banco de dados:
      A conexão com o banco de dados e/ou comando SQL possui erros.

   Se ID inválido ou não encontrado:
      Falha ao liberar registro.

ListarPedidos

  • Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

   Lista os Pedidos considerando sua data de emissão e movimentação.

LitarPedidosDataEmissao

  • Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

ListarPedidosCompleto

Os dados do Pedidos serão listados em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.

  • Parâmetros:


Retornos:
   Se sucesso:

  • Parâmetros para o elemento pedido:

  • Parâmetros para o elemento tipoOperacao:

  • Parâmetros para o elemento unidadeNegocio:

  • Parâmetros para o elemento cliente:

  • Parâmetros para o elemento cobranca:

  • Parâmetros para o elemento representante:

  • Parâmetros para o elemento transportadora:

  • Parâmetros para o elemento consignatario:

  • Parâmetros para o elemento fornecedorEmpresa:

  • Parâmetros para o elemento despachanteEmpresa:

  • Parâmetros para o elemento regiaoMercado:

  • Parâmetros para o elemento contatoEmpresa:

  • Parâmetros para o elemento impostos:

  • Parâmetros para o elemento material:

  • Parâmetros para o elemento compradorFinal:

  • Parâmetros para o elemento unidadeNegocioTransf:

  • Parâmetros para o elemento centroArmazenagem:

  • Parâmetros para o elemento centroArmazenagemTransf:

  • Parâmetros para o elemento tabelaPreco:

  • Parâmetros para o elemento contaGerencial:

  • Parâmetros para o elemento controleItem:

  • Parâmetros para o elemento especif1:

  • Parâmetros para o elemento Lancamento:


  • Distribuição das Tags XML:


  • Distribuição das Tags Json:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

ListarPedidosPorRepresentante

  • Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

CadastrarPedidos

Cadastra pedidos, itens e grades em uma única requisição. Os dados do Pedido deverão estar em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.

  • Parâmetros:


  • Distribuição das Tags XML:


  • Distribuição das Tags Json:


Retornos:
   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se sucesso:
      idRegistro - ID que representa este registro na tabela de integração.

   Se algum parâmetro inválido:
      Parâmetro necessário não informado.

VisualizarPedidoWeb

  • Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Excluir

  • Parâmetros:


Retornos:
   Se sucesso:
      idRegistro - ID que representa este registro na tabela de integração.

   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.