Produtos da loja
Lista os produtos de um seller no formato de produto da API 1.0, em páginas.
Lista os produtos de um seller, no mesmo formato de produto de /api/v1.0/products (preços em string decimal, amount inteiro, datas em Unix). Use para sincronizar o catálogo de um lojista com o ERP dele.
Os produtos vêm do mais novo para o mais antigo. O exemplo abaixo mostra só os campos principais; cada item traz o produto completo da 1.0 (categorias, imagens, características, opções).
/api/v1.0/stores/{id}/productsAdminListar produtos de uma loja
Parâmetros de caminho
iduuidobrigatóriocompany_id por /api/v1.0. O id decimal que a forma /api/... devolve não é aceito aqui.Parâmetros de consulta
pageintegerpadrão: 1items_per_pageintegerpadrão: 10statusstringADHA ativo, D desativado, H oculto).qstring/api/stores/{id}/productsAdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/stores/{id}/products. 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/vendors/{id}/productsAdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/stores/{id}/products. Use este caminho se o seu cliente já foi escrito para ele.
/api/vendors/{id}/productsAdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/stores/{id}/products. 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/companies/{id}/productsAdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/stores/{id}/products. Use este caminho se o seu cliente já foi escrito para ele.
/api/companies/{id}/productsAdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/stores/{id}/products. 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/94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36/products?status=A&items_per_page=20" \
-u "$EMAIL:$API_KEY"Resposta
{
"products": [
{
"product_id": "22fbd12a-1b6e-41ea-a84f-4d9cf06c8766",
"product": "Camisa Masculina Linho",
"product_code": "CAM-LIN-01",
"price": "300.00",
"list_price": "449.90",
"amount": 38,
"status": "A",
"company_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
"seo_name": "camisa-masculina-linho",
"timestamp": 1787625635
}
],
"params": { "company_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36", "items_per_page": 10, "page": 1, "total_items": 4982 }
}Campos da resposta
productsarrayparamsobjectcompany_id (do caminho, na forma de id da rota chamada), page, items_per_page e total_items.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"} |
| 500 | O id não tem formato de UUID (por exemplo o id decimal da forma /api). É uma falha conhecida: deveria ser 404. | {"status":500,"message":"..."} (mensagem interna de erro (não estável)) |