Listando Pacotes
O endereço abaixo pode ser utilizado para listar todos os Pacotes com paginação, retornando até 500 Pacotes por requisição.
GET
/pacotes
{
"current_page": 1,
"data": [
{
"id": 923812093,
"nome": "XXXX XXXXXXXX XXXXXX",
"status": 1,
"produtos": [
{
"id": 943290490,
"nome": "XXXX XXXXXXXX XXXXXX",
"status": 1,
"quantidade": 5
}
]
},
{
"id": 81278492198,
"nome": "XXXX XXXXXXXX XXXXXX",
"status": 1,
"produtos": [
{
"id": 3891273891,
"nome": "XXXX XXXXXXXX XXXXXX",
"status": 1,
"quantidade": 10
}
]
}
],
"first_page_url": "https://ev.kapsula.com.br/api/v1/pacotes?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://ev.kapsula.com.br/api/v1/pacotes?page=1",
"next_page_url": null,
"path": "https://ev.kapsula.com.br/api/v1/pacotes",
"per_page": 500,
"prev_page_url": null,
"to": 2,
"total": 2
}Filtrar pacotes por nome
Caso queria obter um pacote específico ou com nomes parecidos, a requisição deve ser a mesma utilizada ao listar todos os Pacotes, apenas acrescente o parâmetro nome na requisição GET, e insira o nome do pacote.
GET
/pacotes?nome=Pacote x...
Pacotes por Status
Caso queria obter os pacotes de um determinado status, a requisição deve ser a mesma utilizada ao listar todos os Pacotes, apenas acrescente o parâmetro status na requisição GET.
GET
/pacotes?status=x
Observação: O código do status desejado pode ser conferido acessando Possíveis status dos pacotes, código e descrição
Pacotes por período
Caso queria obter os pacotes entre algum determinado período, a requisição deve ser a mesma utilizada ao listar todos os pacotes, acrescentando apenas os parâmetros data_inicio ou data_fim na requisição GET.
GET
/pacotes?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
/pacotes?data_inicio=2019-01-01&data_fim=2019-06-20
GET
/pacotes?data_inicio=2019-04-10
Obtendo um Pacote
Para obter informações de um pacote específico, basta realizar uma requisição do tipo GET na rota /pacotes/ID com o ID do pacote.
GET
/pacotes/ID
{
"id": 923812093,
"nome": "XXXX XXXXXXXX XXXXXX",
"status": 1,
"produtos": [
{
"id": 943290490,
"nome": "XXXX XXXXXXXX XXXXXX",
"status": 1,
"quantidade": 5
}
]
}