Listar lojas
Retorna os sellers da loja com filtro por situação e por texto, em páginas.
Lista os sellers da loja, com filtro por situação e por texto. Use para montar a tela de sellers de um painel, para conciliar o cadastro com um ERP ou para descobrir o UUID de um seller antes de operar nele.
A lista traz o resumo do seller. address, country, zipcode, url e as contagens (product_count, order_count) vêm vazios ou zerados aqui. Para o cadastro completo, use Consultar loja. Sellers excluídos não aparecem. A ordem é fixa: por nome da empresa, de Z para A.
/api/v1.0/storesAdminListar lojas, vendors ou companies
Parâmetros de consulta
pageintegerpadrão: 1items_per_pageintegerpadrão: 10params.items_per_page ainda repete o valor que você pediu. Menor que 1 ou texto vira 10.statusstringAPDRA, P, D, R) ou nome (active, pending, disabled, rejected).companystring/api/storesAdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/stores. Use este caminho se o seu cliente já foi escrito para ele. Na forma sem versão (/api/...) os ids saem como números decimais em string, mas os caminhos só aceitam o UUID (veja a home da seção).
/api/v1.0/vendorsAdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/stores. Use este caminho se o seu cliente já foi escrito para ele. Aqui o vetor da resposta se chama vendors, não stores.
/api/vendorsAdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/stores. Use este caminho se o seu cliente já foi escrito para ele. Na forma sem versão (/api/...) os ids saem como números decimais em string, mas os caminhos só aceitam o UUID (veja a home da seção). Aqui o vetor da resposta se chama vendors, não stores.
/api/v1.0/companiesAdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/stores. Use este caminho se o seu cliente já foi escrito para ele.
/api/companiesAdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/stores. Use este caminho se o seu cliente já foi escrito para ele. Na forma sem versão (/api/...) os ids saem como números decimais em string, mas os caminhos só aceitam o UUID (veja a home da seção).
Exemplo de requisição
curl "$BASE_URL/api/v1.0/stores?status=A&items_per_page=20" \
-u "$EMAIL:$API_KEY"Resposta
{
"stores": [
{
"company_id": "c0000000-0000-0000-0000-000000000001",
"company": "Tech Brasil",
"company_name": "Tech Brasil",
"status": "A",
"email": "contato@techbrasil.example",
"phone": "(11) 3333-4444",
"url": "",
"address": "",
"city": "São Paulo",
"state": "SP",
"country": "",
"zipcode": "",
"storefront": "tech-brasil.venddor.com.br",
"slug": "tech-brasil",
"logo_url": "https://cdn.example/techbrasil.png",
"company_address": "",
"company_city": "São Paulo",
"company_country": "",
"company_state": "SP",
"company_zipcode": "",
"company_phone": "(11) 3333-4444",
"company_website": "",
"avg_rating": 0,
"product_count": 0,
"order_count": 0,
"payments_default": null,
"shippings_default": null,
"countries_list": null
}
],
"params": { "page": 1, "items_per_page": 10, "total_items": 12 }
}Campos da resposta
storesarrayvendors em /vendors). Cada item tem os campos descritos em Consultar loja, com as ressalvas acima.paramsobjectpage, items_per_page, total_items.params.total_items é o total de sellers que atendem ao filtro, em todas as páginas.
Erros
| Status | Quando | Corpo de exemplo |
|---|---|---|
| 401 | Sem credencial. | {"status":401,"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>."} |
| 401 | E-mail ou chave de API inválidos. | {"status":401,"message":"Invalid credentials"} |
| 403 | A credencial é válida, mas o usuário não é administrador. | {"status":403,"message":"Forbidden: admin scope required"} |