Paginação e filtros
Parâmetros de consulta do GET /api/2.0/call_requests que paginam, ordenam e filtram a lista de pedidos de ligação.
Use estes parâmetros para encontrar pedidos de ligação com propriedades específicas e exibi-los do jeito que precisar. Eles ajudam a navegar e filtrar os dados com eficiência.
/api/2.0/call_requestsAdminRetorna pedidos de ligação com paginação, ordenação e filtros
Paginação e ordenação
pageintegerpadrão: 1Mostra os pedidos de ligação da página de saída com o número informado.
items_per_pageintegerpadrão: 10A quantidade de pedidos de ligação exibidos em uma página de saída.
sort_bystringpadrão: dateiddatestatusnamephoneuser_iduserorderorder_statusOrdena os pedidos de ligação por este campo.
sort_orderstringpadrão: descascdescOrdem crescente ou decrescente.
Filtros
statusstringnewin_progresscompletedno_answerFiltra os pedidos de ligação por status.
namestringFiltra os pedidos de ligação por nome.
phonestringFiltra os pedidos de ligação pelo número de telefone.
company_idintegerFiltra os pedidos de ligação pelo ID da loja (se você tem várias lojas).
order_statusstringFiltra os pedidos de ligação pelo status do pedido associado (feito com Comprar com 1 clique).
user_idstringFiltra os pedidos de ligação pelos IDs dos administradores atribuídos a esses pedidos.
order_existsstringYNFiltra os pedidos de ligação conforme exista ou não um pedido associado:
Y (o pedido existe), N (o pedido não existe).Exemplos
Paginação básica
Esta requisição retorna um array com 20 pedidos de ligação da 1ª página de saída.
bash
curl "$BASE_URL/api/2.0/call_requests?items_per_page=20" \
-u "$EMAIL:$API_KEY"Filtro com vários parâmetros
Esta requisição retorna um array com 20 pedidos de ligação sem pedido associado, a partir da 5ª página de saída.
bash
curl "$BASE_URL/api/2.0/call_requests?page=5&items_per_page=20&order_exists=N" \
-u "$EMAIL:$API_KEY"