VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Pedidos de ligação

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.

GET/api/2.0/call_requestsAdmin

Retorna pedidos de ligação com paginação, ordenação e filtros

Paginação e ordenação

pageintegerpadrão: 1
Mostra os pedidos de ligação da página de saída com o número informado.
items_per_pageintegerpadrão: 10
A quantidade de pedidos de ligação exibidos em uma página de saída.
sort_bystringpadrão: date
iddatestatusnamephoneuser_iduserorderorder_status
Ordena os pedidos de ligação por este campo.
sort_orderstringpadrão: desc
ascdesc
Ordem crescente ou decrescente.

Filtros

statusstring
newin_progresscompletedno_answer
Filtra os pedidos de ligação por status.
namestring
Filtra os pedidos de ligação por nome.
phonestring
Filtra os pedidos de ligação pelo número de telefone.
company_idinteger
Filtra os pedidos de ligação pelo ID da loja (se você tem várias lojas).
order_statusstring
Filtra os pedidos de ligação pelo status do pedido associado (feito com Comprar com 1 clique).
user_idstring
Filtra os pedidos de ligação pelos IDs dos administradores atribuídos a esses pedidos.
order_existsstring
YN
Filtra os pedidos de ligação conforme exista ou não um pedido associado: Y (o pedido existe), N (o pedido não existe).
Dica

Ao filtrar por vários parâmetros, combine-os no formato padrão de query string, com & entre os parâmetros.

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"
Conte as páginas

Confira sempre o total na resposta para saber quantas páginas existem. Essa informação costuma vir nos metadados da resposta.

Veja também

  • Endpoints de pedidos de ligação
  • Campos do pedido de ligação
Anterior
Endpoints de pedidos de ligação
Próxima
Campos do pedido de ligação
Nesta página
  • Exemplos
  • Paginação básica
  • Filtro com vários parâmetros
  • Veja também