Produtos
Listando Produtos
O endereço abaixo pode ser utilizado para listar todos os produtos com paginação, retornando até 500 produtos por requisição.
GET
/produtos
{ "current_page": 1, "data": [ { "id": 38921741, "nome": "XXXXX XXXXX XXXX", "status": 1 }, { "id": 48894249, "nome": "XXXXX XXXXX", "status": 1 }, { "id": 38219032, "nome": "XXXXX XXXXX XXXX XXXXXXX", "status": 1 } ], "first_page_url": "https://ev.kapsula.com.br/api/v1/produtos?page=1", "from": 1, "last_page": 1, "last_page_url": "https://ev.kapsula.com.br/api/v1/produtos?page=1", "next_page_url": null, "path": "https://ev.kapsula.com.br/api/v1/produtos", "per_page": 500, "prev_page_url": null, "to": 3, "total": 3 }
Produtos por Status
Caso queria obter os produtos de um determinado status, a requisição deve ser a mesma utilizada ao listar todos os produtos, apenas acrescente o parâmetro status
na requisição GET
.
GET
/produtos?status=x
Observações:
- O código do status desejado pode ser conferido acessando Possíveis status dos produtos, código e descrição.
- Por padrão os produtos retornados possuem um filtro para retornar produtos ativos.
Produtos por período
Caso queria obter os produtos entre algum determinado período, a requisição deve ser a mesma utilizada ao listar todos os produtos, acrescentando apenas os parâmetros data_inicio
ou data_fim
na requisição GET
.
GET
/produtos?data_inicio=xxxx-xx-xx&data_fim=xxxx-xx-xx
Observação: O formato das datas a serem passadas na requisição devem seguir o seguinte padrão de ANO-MES-DIA
, podendo ou não ser passada a data_fim
, caso a data_fim
não seja passado será considerado a data atual como fim.
A seguir segue 2 exemplos de requisição passando um período valido:
GET
/produtos?data_inicio=2019-01-01&data_fim=2019-06-20
GET
/produtos?data_inicio=2019-04-10
Obtendo um Produto
Para obter informações de um produto específico, basta realizar uma requisição do tipo GET
na rota /produtos/ID
com o ID
do produto.
GET
/produtos/ID
{ "id": 38921741, "nome": "XXXXX XXXXX XXXX", "status": 1 }