Home TOTVS Varejo Supermercados

Árvore de páginas

GET {urlbase}:{porta}/smpedidovendaapi/api/v1/PedidoVenda/status


Endpoint responsável por retornar situação referente a integração do pedido no ERP.

Após o envio do pedido pela API através do endpoint POST /smpedidovendaapi/api/v1/PedidoVenda

é necessário consultar o status do pedido, para garantir que não caiu em uma crítica do sistema ERP.


PARÂMETROS DO CAMINHO

Nome

seqPedido Inteiro *Obrigatório

Sequencial do pedido recebido ao cadastrar um pedido pelo endpoint POST /smpedidovendaapi/api/v1/PedidoVenda

*Caso deseje pesquisar pelo seqCanalVenda e IdPedidoCanalVenda o seqPedido não precisa ser preenchido.

SeqCanalVenda Texto *Obrigatório

Sequencial do Canal de Venda

*Caso deseje consultar pelo canal de venda, é necessário o parâmetro IdPedidoCanalVenda na pesquisa. 

IdPedidoCanalVenda DataHora *Obrigatório

Identificação do Pedido de Venda no sistema parceiro

*Caso deseje consultar pelo id pedido canal de venda, é necessário o parâmetro SeqCanalVenda na pesquisa. 

Expand Texto

Caso preenchido com o valor "critica", no retorno terá detalhes da lista de críticas constantes no pedido caso exista.


RESPOSTA


Resposta Pedido Finalizado

Resposta Recebida
{
    "seqPedido": 48,
    "seqCanalVenda": 1,
    "idPedidoCanalVenda": "125",
    "nroEmpresa": 1,
    "statusIntegracao": "Finalizado",
    "nroPedVenda": 1579,
    "_expandables": []
}

Resposta Pedido Rejeitado

{
    "seqPedido": 35,
    "seqCanalVenda": 1,
    "idPedidoCanalVenda": "123",
    "nroEmpresa": 1,
    "statusIntegracao": "Rejeitado",
    "nroPedVenda": null,
    "critica": [
        {
            "descricao": "Descrição da critica.",
            "detalhe": "Detalhe",
            "tipoCritica": "Cliente",
            "origem": "Sistema"
        },
        {
            "descricao": "Descrição da critica.",
            "detalhe": "Detalhe",
            "tipoCritica": "Cliente",
            "origem": "Sistema" 
        }
    ],
    "_expandables": [
        "critica"
    ]
}



Resposta de Erro

{
    "code": "Zvpebfbsg.NfcArgPber.Zip.GasPbagebyyre+Reebe.2",
    "message": "Erro ao salvar 'PedidoVenda'",
    "detailedMessage": "AspNetCoreOnPostError",
    "helpUrl": "",
    "details": [
        {
            "guid": "be5f6a5c-1116-46fa-9d9f-d7f4b696ba27",
            "code": "400",
            "message": "Mensagem de erro.",
            "detailedMessage": "Fetalhe"
        }
    ]
}

CRÍTICAS

Durante a consulta do status de pedido é possível que retorne o campo statusIntegracao como "Rejeitado", isso ocorre durante o processamento do pedido onde são feitas algumas validações do ERP as quais invalidam a integração do pedido no ERP. Nesse caso, poderá ver detalhes das criticas no retorno da consulta. Para detalhá-las no retorno, lembre-se de usar "Expand" no path params da requisição.


Exemplo de críticas efetuadas durante o processamento do pedido

Descrição: Empresa não encontrada.
Detalhe: Verifique o cadastro de empresas para a empresa informada.
Número da empresa informada: 999

Descrição: Segmento não encontrado para a empresa informada no ERP.
Detalhe: Verifique o cadastro do canal de venda para a empresa informada.
Número da empresa informada: 999
Descrição: Representante não cadastrado.
Detalhe: Número do representante informado: 999
Descrição: CGO não cadastrado.
Detalhe: Número do CGO informado: 999
Descrição: Tabela de venda não cadastrada.
Detalhe: Número da tabela de venda informada: 999
Descrição: Canal de venda não cadastrado.
Detalhe: Número do canal de venda informado: 999
Descrição: Segmento não cadastrado no sistema.
Detalhe: Número do segmento informado: 999
Descrição: Pedido já integrado no sistema com esse IdPedido e Canal de venda.
Detalhe: IdPedido 999 SeqCanalVenda 999
Descrição: Transportador não cadastrado.
Detalhe: Número do transportador informado: 999
Descrição: SeqProduto informado não cadastrado no sistema.
Detalhe: Seqproduto 999
Descrição: Percentual de comissão do item maior ou igual a 100%.
Detalhe: Seqproduto 999 Seqitemcanalvenda 999
Descrição: Número da Forma de Pagamento informado não cadastrado no sistema.
Detalhe: NroFormaPagto: 999.
Descrição: Número da Condição de Pagamento informado não cadastrado no sistema.
Detalhe: NroCondPagto: 999.


INSTALAÇÃO

Para instalação do módulo de API Pedido de Venda deve ser feito via PublicaWeb > ConsincoWeb

Pacote: Comercial Pedido de Venda API

Versão a partir de: 23.01.001

  • Sem rótulos