01. DADOS GERAIS
| Linha de Produto: | Virtual Age |
|---|---|
| Segmento: | Moda |
| Módulo: | Integração |
| Função: | saldoProduto |
| Requisito/Story/Issue (informe o requisito relacionado) : | DVAITG-2371 |
02. SITUAÇÃO/REQUISITO
Criar a web api de consulta de saldo de produto no projeto VirtualAge.
03. SOLUÇÃO
Foi criada a web API saldoProduto no projeto VirtualAge.
Esta recebe como parâmetro uma lista de produtos com os atributos:
cdProduto - Código do produto
cdSaldo - Código do tipo de saldo de produto
inEstoque - Indicador de retorno de quantidade de estoque de produto - "1" para retornar ou "0" para não retornar
inPedidoVenda - Indicador de retorno de quantidade de produto em pedido de venda - "1" para retornar ou "0" para não retornar
cdEmpresa - Código da empresa
nrCNPJEmpresa - Número de CNPJ da empresa
O retorno desta consulta poderá possuir os atributos:
cdSKU - Código SKU(código reduzido do produto no ERP)
cdProduto - Código reduzido do produto no ERP
cdReferencia - Código de referência do produto
cdCor - Código da cor do produto
dsTamanho - Descrição do tamanho da cor do produto
cdEmpresa - Código da empresa
nrCNPJEmpresa - Número de CNPJ da empresa
qtEstoque - Quantidade de produto em estoque
qtPedidoVenda - Quantidade de produto em pedido de venda
04. DEMAIS INFORMAÇÕES
Processo:
•Obter Token
O token é necessário ser gerado para utilização nas demais APIs como por exemplo a API saldoProduto. Antes de requisitar o token, é necessário solicitação de usuário e senha de WebService/API a TOTVS-Cianorte. A seguir, informações para acionar a API de obtenção de token:
URL | |
Método | POST |
Header | usuario string senha string |
Exemplo de retorno | { "cdToken": "jdfq948dfgnahsdjrhvnq3948yvbdhfvajkshv3q498ybvnashcaer...", "dtExpiracao": "01/05/2019 09:33:10" } |
Exemplo de obtenção de token utilizando o programa POSTMAN:
•Consultar saldo de produto API
A seguir, exemplo de consumo da API de saldoProduto. Em body(corpo), deverá ser informado conforme exemplo.
O atributo cdProduto deve ser informado uma ou mais vezes, assim como cdEmpresa(ou nrCNPJEmpresa). Os atributos inEstoque e inPedidoVenda são indicadores que consideram valor "1" para retornar a informação, e valor "0" para não retornar informação.
URL | |
Método | POST |
Header | Authorization Bearer jdfq948dfgnahsdjrhvnq3948yvbdhfvajkshv3q498ybvnashcaer... Content-Type text/json ou application/json |
Body | { "produtos": [ { "cdProduto": "14" }, { "cdProduto": "15" } ], "cdSaldo": 1, "inEstoque": 1, "inPedidoVenda": 1, "empresas": [ { "cdEmpresa": 0, "nrCNPJEmpresa": "80187156000162" }, { "cdEmpresa": 2 } ] } |
Exemplo de retorno | { "saldos": [ { "cdSKU": 14, "cdProduto": "14", "cdReferencia": ".7 1 1 ALT", "cdCor": "010", "dsTamanho": "38", "cdEmpresa": 1, "nrCNPJEmpresa": "80187156000162", "qtEstoque": 992, "qtPedidoVenda": 120 }, { "cdSKU": 14, "cdProduto": "14", "cdReferencia": ".7 1 1 ALT", "cdCor": "010", "dsTamanho": "38", "cdEmpresa": 2, "nrCNPJEmpresa": "43675478000124", "qtEstoque": 465, "qtPedidoVenda": 75 }, { "cdSKU": 15, "cdProduto": "15", "cdReferencia": ".7 1 1 ALT", "cdCor": "010", "dsTamanho": "39", "cdEmpresa": 1, "nrCNPJEmpresa": "80187156000162", "qtEstoque": 986, "qtPedidoVenda": 80 }, { "cdSKU": 15, "cdProduto": "15", "cdReferencia": ".7 1 1 ALT", "cdCor": "010", "dsTamanho": "39", "cdEmpresa": 2, "nrCNPJEmpresa": "43675478000124", "qtEstoque": 443, "qtPedidoVenda": 90 } ] } |
Exemplo de consulta de saldo de produto utilizando o programa POSTMAN:
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas