Paginação, ordenação e filtros
Parâmetros de consulta do GET /api/carts que definem quais carrinhos voltam, em que ordem e em qual página.
Acrescente estes parâmetros ao caminho da requisição GET /api/carts para definir quais carrinhos serão retornados na resposta e como eles serão organizados. Eles ajudam você a navegar pelos dados dos carrinhos com eficiência e a focar nas informações relevantes.
/api/cartsAdminRetornar uma lista de carrinhos de compras com paginação e filtros
Parâmetros de paginação
pageintegerpadrão: 1GET /api/carts/ é uma página com um número limitado de carrinhos. Este parâmetro define o número da página que será enviada na resposta.items_per_pageintegerpadrão: 10Parâmetros de ordenação
sort_bystringpadrão: datecustomerdatecustomer (cliente) ou date (data).sort_orderstringpadrão: descascdescasc é crescente e desc é decrescente.Parâmetros de filtro por cliente
cnamestringFiltra os carrinhos pelo nome do usuário. Você não precisa usar o nome completo: basta uma sequência de letras de qualquer parte do nome ou do sobrenome. Por exemplo, com cname=do você encontra os carrinhos de John Doe, Dorian Gray etc.
emailstringuser_idstringusers_typestringRGR são usuários cadastrados e G são visitantes (guests).Parâmetros de filtro por conteúdo do carrinho
with_info_onlybooleanpadrão: falsetrue, a resposta inclui só os carrinhos de usuários que informaram dados de contato.product_type_cbooleanpadrão: falsetrue, a resposta inclui só os usuários que têm algo no carrinho.product_type_wbooleanpadrão: falsetrue, a resposta inclui só os usuários que têm algo na lista de desejos.total_fromstringtotal_tostringp_idsstringMostra os carrinhos com os ids de produto informados. Há duas formas de usar p_ids: como array, p_ids[]=1&p_ids[]=2&p_ids[]=3, ou como string, p_ids=1,2,3,4,5.
Parâmetros de período
periodstringADLDWLWMLMYLYHHHWHMCFiltra os carrinhos por período. A é todo o período, D é hoje, LD é o dia anterior, W é a semana atual, LW é a semana passada, M é o mês atual, LM é o mês passado, Y é o ano atual, LY é o ano passado, HH são as últimas 24 horas, HW são os últimos 7 dias, HM são os últimos 30 dias e C é um período específico (use com time_from e time_to).
time_fromintegertime_tointegerExemplos
Paginação básica
A resposta é um array com 20 carrinhos da 1ª página.
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/carts/?items_per_page=20"Filtros combinados
A resposta é um array com 20 carrinhos de visitantes de hoje, da 5ª página. A referência escreve este exemplo com o nome user_type, enquanto a própria tabela de parâmetros chama o parâmetro de users_type.
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/carts/?page=5&items_per_page=20&period=D&user_type=G"Formato da resposta
Veja uma requisição de exemplo para entender a estrutura da resposta: GET /api/carts/. Se a requisição der certo, você recebe HTTP/1.1 200 OK. A resposta é um JSON com esta estrutura.
{
"carts": [
{
"user_id": "3810267128",
"firstname": null,
"lastname": null,
"date": "1466409032",
"ip_address": "127.0.0.1",
"company_id": "1",
"cart_products": "1",
"total": "30.00",
"order_id": null,
"user_data": []
},
{
"user_id": "3",
"firstname": "John",
"lastname": "Doe",
"date": "1466409025",
"ip_address": "127.0.0.1",
"company_id": "1",
"cart_products": "1",
"total": "30.00",
"order_id": null,
"user_data": {
"user_id": "3",
"status": "A",
"user_type": "C",
"user_login": "customer",
"email": "customer@example.com",
"phone": "77 77 777 7777",
"b_firstname": "John",
"b_lastname": "Doe",
"b_address": "44 Main street",
"b_city": "Boston",
"b_state": "MA",
"b_country": "US",
"b_zipcode": "02134"
// Additional user data omitted for brevity
}
}
],
"params": {
"page": 1,
"items_per_page": 10,
"company_id": "1",
"sort_order": "asc",
"sort_by": "customer",
"sort_order_rev": "desc",
"total_items": "2"
}
}