Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

POST  {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.


Índice


EXEMPLO DA RESPOSTA RECEBIDA DE PEDIDO INTEGRADO COM SUCESSO

Bloco de código
languagejs
{
    "seqPedido": 48,
    "seqCanalVenda": 1,
    "idPedidoCanalVenda": "125",
    "nroEmpresa": 1,
    "statusIntegracao": "Finalizado",
    "nroPedVenda": 1579,
    "_expandables": []
}


EXEMPLO DA RESPOSTA RECEBIDA DE PEDIDO REJEITADO

Bloco de código
languagejs
{
    "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"
    ]
}

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


Dica

200

ok




Aviso

400

Falha

Bloco de código
{
    "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"
        }
    ]
}



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