Wiki source code of Produtos - Situação por Codigo
Last modified by WBS Tecnologia on 2021/06/11 21:27
Hide last authors
author | version | line-number | content |
---|---|---|---|
![]() |
1.1 | 1 | (% class="jumbotron" %) |
2 | ((( | ||
3 | (% class="container" %) | ||
4 | ((( | ||
![]() |
10.1 | 5 | = Consulta um Produto pelo seu Código de Barras = |
![]() |
11.1 | 6 | |
7 | |||
![]() |
1.1 | 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 | ((( | ||
![]() |
11.1 | 19 | Rota: /BDIApi/Produto/Situacao?codigo=XXXXXXX |
![]() |
1.1 | 20 | ))) |
21 | |||
![]() |
3.1 | 22 | * Parâmetros: |
![]() |
7.1 | 23 | ** codigo = [Obrigatório] Código de Barras do Produto |
![]() |
1.1 | 24 | * Requer Autenticação: **Sim ** |
![]() |
2.1 | 25 | * Método: **GET** |
![]() |
10.1 | 26 | * Tipo de Retorno**: Void | Produto** |
![]() |
2.1 | 27 | * Headers: |
28 | ** API_TOKEN: Token de Autenticação | ||
![]() |
1.1 | 29 | |
30 | == Códigos de Status == | ||
31 | |||
![]() |
2.1 | 32 | * 404 = Sem resultados |
![]() |
1.1 | 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 | |||
![]() |
11.1 | 39 | Consulta um Produto Específico pelo seu código de barras e Traz uma Versão Resumida dos Dados do Produto |
![]() |
1.1 | 40 | |
![]() |
2.1 | 41 | === (% style="font-size:26px" %)Headers(%%) === |
![]() |
1.1 | 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 | ||
![]() |
2.1 | 46 | |API_TOKEN|[Obrigatório] Token da Autenticação| |
![]() |
1.1 | 47 | |
![]() |
2.1 | 48 | == (% style="font-size:29px" %)Detalhes do Resultado(%%) == |
![]() |
1.1 | 49 | |
50 | Este é o Payload do resultado caso a ação tenha sucesso: | ||
51 | |||
52 | {{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}} | ||
![]() |
7.1 | 53 | { |
![]() |
11.1 | 54 | "CodigoDeBarras": "9786555122817", |
![]() |
10.1 | 55 | "Estoque": 0, |
56 | "Preco": 29.90, | ||
![]() |
11.1 | 57 | "PodeEncomendar": false, |
![]() |
10.1 | 58 | "Situacao": 2, |
![]() |
11.1 | 59 | "AtualizadoEm": "2021-05-18T11:24:30", |
![]() |
10.1 | 60 | "Visivel": true, |
![]() |
11.1 | 61 | "Id": 0, |
![]() |
10.1 | 62 | "Versao": null |
![]() |
7.1 | 63 | } |
![]() |
1.1 | 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 | ))) |