Wiki source code of Produtos - Situação por Codigo
Last modified by WBS Tecnologia on 2021/06/11 21:27
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | (% class="jumbotron" %) | ||
2 | ((( | ||
3 | (% class="container" %) | ||
4 | ((( | ||
5 | = Consulta um Produto pelo seu Código de Barras = | ||
6 | |||
7 | |||
8 | ))) | ||
9 | ))) | ||
10 | |||
11 | (% class="row" %) | ||
12 | ((( | ||
13 | (% class="col-xs-12 col-sm-8" %) | ||
14 | ((( | ||
15 | = Detalhes da Rota = | ||
16 | |||
17 | (% class="box infomessage" %) | ||
18 | ((( | ||
19 | Rota: /BDIApi/Produto/Situacao?codigo=XXXXXXX | ||
20 | ))) | ||
21 | |||
22 | * Parâmetros: | ||
23 | ** codigo = [Obrigatório] Código de Barras do Produto | ||
24 | * Requer Autenticação: **Sim ** | ||
25 | * Método: **GET** | ||
26 | * Tipo de Retorno**: Void | Produto** | ||
27 | * Headers: | ||
28 | ** API_TOKEN: Token de Autenticação | ||
29 | |||
30 | == Códigos de Status == | ||
31 | |||
32 | * 404 = Sem resultados | ||
33 | * 500 = Erro Interno do Servidor | ||
34 | * 200 = OK | ||
35 | * 403 = Acesso Negado, Token de Autenticação Inválido? | ||
36 | |||
37 | = Detalhes da Ação = | ||
38 | |||
39 | Consulta um Produto Específico pelo seu código de barras e Traz uma Versão Resumida dos Dados do Produto | ||
40 | |||
41 | === (% style="font-size:26px" %)Headers(%%) === | ||
42 | |||
43 | Abaixo segue os headers que devem ou podem ser passados para a ação: | ||
44 | |||
45 | |=Header|=Descrição / Validação|=Valor Padrão | ||
46 | |API_TOKEN|[Obrigatório] Token da Autenticação| | ||
47 | |||
48 | == (% style="font-size:29px" %)Detalhes do Resultado(%%) == | ||
49 | |||
50 | Este é o Payload do resultado caso a ação tenha sucesso: | ||
51 | |||
52 | {{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}} | ||
53 | { | ||
54 | "CodigoDeBarras": "9786555122817", | ||
55 | "Estoque": 0, | ||
56 | "Preco": 29.90, | ||
57 | "PodeEncomendar": false, | ||
58 | "Situacao": 2, | ||
59 | "AtualizadoEm": "2021-05-18T11:24:30", | ||
60 | "Visivel": true, | ||
61 | "Id": 0, | ||
62 | "Versao": null | ||
63 | } | ||
64 | {{/code}} | ||
65 | ))) | ||
66 | |||
67 | |||
68 | (% class="col-xs-12 col-sm-4" %) | ||
69 | ((( | ||
70 | {{box title="**Índice**"}} | ||
71 | {{toc/}} | ||
72 | {{/box}} | ||
73 | |||
74 | {{box}} | ||
75 | **Exemplos** | ||
76 | |||
77 | * Exemplo de Payload: BAIXAR | ||
78 | * Exemplo de Resultado: BAIXAR | ||
79 | {{/box}} | ||
80 | ))) | ||
81 | ))) |