GET - Consulta Pedido de Venda

Este método consulta pedidos de venda cadastrados no Prosyst a partir dos parâmetros informados na URL.

Exemplo 1 (Busca por pedidos específicos)

api/PedidoVenda/Consulta?NrPedido=1,2,3

Exemplo 2 (Pedidos cadastrados em um intervalo de datas)

api/PedidoVenda/Consulta?DataCadastroInicial=2021-06-01T00:00:00&DataCadastroFinal=2021-06-15T23:59:59

Exemplo 3 (Pedidos que tiveram modificação a partir de uma data)

api/PedidoVenda/Consulta?DataUltimaAlteracaoInicial=2021-08-01T15:30:00

Exemplo 4 (Busca por pedidos em um estabelecimento específico.)

api/PedidoVenda/Consulta?NrPedido=1&ConexaoBanco=conexaoTeste

Parâmetros URL

Especifique os parâmetros abaixo para determinar quais pedidos serão retornados:

NrPedido=(nr. pedido)[,nr. pedido2, nr. pedidoN] **- Especifica um ou mais números de pedidos específicos que deverão ser obtidos. Informe vários números de pedido separados por vírgula (,). Se este parâmetro for especificado, os demais parâmetros serão automaticamente ignorados. * **DataCadastroInicial / **DataCadastroFinal** - Informar data de início/fim no formato “YYYY-MM-DDTHH:MI:SS”. Especifica o intervalo de data de cadastro dos pedidos. Pode-se também especificar somente uma das datas (Início ou Fim). Se somente uma das datas for especificada, assume-se o intervalo de 30 dias para a data do outro extremo (pode ser diferente caso o cliente o tenha configurado assim).
DataUltimaAlteracaoInicial / DataUltimaAlteracaoFinal **-Informar data de início/fim no formato “YYYY-MM-DDTHH:MI:SS”. Especifica o intervalo de data de última modificação dos pedidos. Pode-se também especificar somente uma das datas (Início ou Fim). Se somente uma das datas for especificada, assume-se o intervalo de 30 dias para a data do outro extremo (pode ser diferente caso o cliente o tenha configurado assim). * **ConexaoBanco ** - (Opcional) Informar o estabelecimento no qual se deseja realizar a consulta. * **SituacaoPedido **- (Opcional) Informar um destes valores: * **SituacaoPedido=P - Indica que somente pedidos pendentes (isto é, que ainda não foram faturados) devem ser retornados.
- **SituacaoPedido=L **- Indica que somente pedidos liquidados (isto é, que já foram faturados e encerrados) devem ser retornados.
- **SituacaoPedido=C **- Indica que somente pedidos Cancelados devem ser retornados.
- **(vazio) - **Caso não informado, trará ambos pedidos Pendentes e Liquidados e Cancelados.
**CodigoEstabelecimento **- (Opcional) Informar o código do estabelecimento a qual deseja realizar a consulta.
**PedidosSemAprovacao **- (Opcional) Informar valor true para busca exclusiva de pedidos de venda sem aprovação e false para busca exclusiva de pedidos aprovados.
**Etapa ** - (Opcional) Informar a etapa do pedido de venda a qual deseja busca.

Observações: O sistema sempre obrigará informar (ao menos) um destes parâmetros:

NrPedido, DataUltimaAlteracaoFinal, DataCadastroFinal, DataUltimaAlteracaoInicial, DataUltimaAlteracaoFinal.

Retorno Simplificado:

Para o retorno simplificado deve ser adicionado no arquivo appsettings.json a propriedade “API_PEDIDOVENDA_RETORNO_SIMPLIFICADO” como true

Parâmetros do Header

auth	Token adquirido no Login.

Exemplos de Retorno

Sucesso

{
    "bemSucedido": true,
    "mensagemFalha": null,
    "novoCodigo": null,
    "dados": [
        {
            "numeroPedido": 191132,
            "situacaoPedido": "Liquidado",
            "dataAprovacao": "2021-09-02T00:00:00.0000000-03:00",
            "codCliente": 157,
            "nomeCliente": "Tim Maia",
            "cpfCnpj": 18821388000157,
            "codTabelaPreco": 17,
            "representante": 1,
            "operadorLogistico": 0,
            "observacao": null,
            "observacaoNotaFiscal": "",
            "avisoFaturamento": "",
            "tipoFrete": 2,
            "tipoFreteDescricao": "Pago (CIF)",
            "valorFrete": 0,
            "transportadora": 5,
            "transportadoraDescricao": "TNT MERCURIO CARGAS E ENC EXPRESS S/",
            "viaTransporte": 0,
            "redespacho": 0,
            "condicaoPgto": 0,
            "pedidoCliente": "",
            "vendedor": 5,
            "descricaoVendedor": "Vendedor Modelo",
            "vendedor2": 0,
            "descricaoVendedor2": null,
            "tipoFat": 0,
            "finalidade": 0,
            "pctRedICMS": 0,
            "percentualDescontoMateriais": 0,
            "valorDescontoMateriais": 0,
            "enderecoEntrega": {
                "documento": 0,
                "tipoDocumento": 1,
                "nomeDestinatario": null,
                "endereco": null,
                "complemento": null,
                "numeroEndereco": null,
                "bairro": null,
                "codMunicipio": 0,
                "descricaoMunicipio": null,
                "siglaEstado": null,
                "cep": 0,
                "telefone": null,
                "celular": null
            },
            "enderecoCobranca": {
                "documento": 0,
                "tipoDocumento": 1,
                "nomeDestinatario": null,
                "endereco": null,
                "complemento": null,
                "numeroEndereco": null,
                "bairro": null,
                "codMunicipio": 0,
                "descricaoMunicipio": null,
                "siglaEstado": null,
                "cep": 0,
                "telefone": null,
                "celular": null
            },
            "percentualComissao": 0,
            "dataCadastro": "2021-09-02T00:00:00.0000000-03:00",
            "tpSaida": 0,
            "valorAntecipacao": 0,
            "valorTotalPedido": 305.58,
            "codigoSituacao": "L",
            "descricaoSituacao": "Liquidado",
            "codProjeto": "PROJ1",
            "descProjeto": "Descrição do Projeto 1",
            "itens": [
                {
                    "codigoProduto": 554,
                    "codigoProdutoEditado": "D05944S454DAA",
                    "descricaoMaterial": "ACABAMENTO",
                    "quantidadePedida": 500.0000,
                    "quantidadeEntregue": 392.0000,
                    "quantidadeCancelada": 108.0000,
                    "quantidadeSaldo": 0.0000,
                    "prazoEntrega": "2021-12-27T00:00:00.0000000-03:00",
                    "percentualDesconto": 0,
                    "percentualComissao": 0,
                    "precoUnitario": 0.779550,
                    "precoUnitarioLista": 0,
                    "percentualIPI": 0,
                    "percentualICMS": 0.0,
                    "percentualReducaoBaseICMS": 0.0,
                    "valorICMS": 0.0,
                    "precoTotal": 0.0000000000,
                    "cfop": 6124,
                    "naturezaOperacao": 71,
                    "sequenciaPedidoCliente": 0,
                    "sequenciaItemPedido": 1,
                    "codTabelaPreco": 0,
                    "cor": 0,
                    "itemPersonalizado": false,
                    "nrPedidoCliente": "",
                    "servico": false,
                    "horaEntrega": {
                        "days": 0,
                        "hours": 0,
                        "minutes": 0,
                        "seconds": 0,
                        "milliseconds": 0
                    },
                    "observacao": "",
                    "codigoStatus": 8,
                    "descricaoStatus": "Liquidado",
                    "codProjeto": "PROJ2",
                    "descProjeto": "Descrição do Projeto 2"

                }
            ],
            "parcelas": [],
            "notas": [
                {
                    "numero": 76108,
                    "serie": "1",
                    "dataEmissao": "2021-09-02T00:00:00.0000000-03:00",
                    "valor": 137.05
                }
            ]
        }
    ]
}

Sucesso Simplificado

{
  "numeroPedido": 0,
  "situacaoPedido": "string",
  "codCliente": 0,
  "nomeCliente": "string",
  "cpfCnpjFormatado": "string",
  "vendedor": 0,
  "descricaoVendedor": "string",
  "enderecoCliente": {
    "documento": 0,
    "tipoDocumento": "TipoDocumentoResponse",
    "nomeDestinatario": "string",
    "endereco": "string",
    "complemento": "string",
    "numeroEndereco": "string",
    "bairro": "string",
    "codMunicipio": 0,
    "descricaoMunicipio": "string",
    "siglaEstado": "string",
    "cep": 0,
    "telefone": "string",
    "celular": "string"
  },
  "valorTotalPedido": 0.0,
  "codigoEstabelecimento": 0,
  "descricaoEstabeleciemtno": "string",
  "codigoEtapa": 0,
  "descricaoEtapa": "string"
}

Sem resultados no retorno

{
  "bemSucedido": false,
  "mensagemFalha": "Nenhum pedido encontrado.",
  "novoCodigo": null,
  "dados": null
}