Produtos da categoria

Lista os produtos ligados diretamente a uma categoria com paginação.

Use esta operação para saber o que há dentro de uma categoria: montar uma vitrine em outro canal, conferir se uma categoria está vazia antes de excluí-la ou exportar o catálogo categoria por categoria.

Um produto tem uma categoria principal e pode estar ligado a várias outras (as "adicionais"). A lista de uma categoria traz os produtos ligados diretamente a ela, seja como principal ou como adicional. Os produtos das categorias filhas não entram: para ter a árvore inteira, percorra as filhas (Listar categorias) e junte as listas.

GET/api/v1.0/categories/{id}/productsAdmin

Produtos de uma categoria

Autenticação: HTTP Basic com e-mail:chave_de_api, ou Bearer <JWT>. A leitura aceita qualquer credencial válida da loja. A ordem é pela posição do produto, crescente.

Parâmetros de caminho

idstringobrigatório

UUID da categoria ou o slug dela.

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250. Valores fora desse intervalo ou que não são número valem 10.

GET/api/categories/{id}/productsAdmin

Produtos de uma categoria (rota sem /v1.0)

A mesma operação sem o /v1.0, com os mesmos parâmetros. Os ids dos produtos na resposta saem como UUID. O {id} aceita UUID ou slug, não o category_id decimal da listagem de categorias nessa rota.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/categories/escritorio/products?items_per_page=50&page=1"

Resposta

200Produtos retornados

json

{
  "params": { "page": 1, "items_per_page": 1, "total_items": 304 },
  "products": [
    {
      "product_id": "7ad9ac4c-6f53-401b-ba56-8a6585c28df2",
      "product": "Mesa Clássico Cinza 03573 - PROMOÇÃO",
      "product_code": "SD-003573",
      "status": "A",
      "price": "69.90",
      "list_price": "82.48",
      "amount": 472,
      "main_category": "698ce279-0cd1-402f-805d-3364e7e9d793",
      "category_ids": ["698ce279-0cd1-402f-805d-3364e7e9d793"],
      "company_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "seo_name": "mesa-classico-cinza-03573-3573",
      "timestamp": 1625129880
    }
  ]
}

Campos da resposta

productsarray

Produtos da página, no mesmo formato da API legada de produtos (a lista completa de campos está na seção de produtos do guia rápido). O exemplo mostra só os campos principais.

products[].product_idstring

UUID do produto.

products[].productstring

Nome do produto.

products[].pricestring

Preço como string decimal com ponto ("69.90" = R$ 69,90). O mesmo vale para list_price.

products[].main_categorystring

Id da categoria principal do produto. Pode ser outra que a consultada, quando o produto está nela como adicional.

products[].category_idsarray

Ids das categorias do produto.

paramsobject

Paginação: page, items_per_page e total_items.

Erros

Status	Quando	Corpo
401	Sem credenciais ou chave inválida	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
500	`{id}` que não é UUID nem slug existente (inclui o id decimal da rota `/api/`)	`{"message":"...","status":500}`

Uma categoria sem produtos, ou um UUID que não existe, devolve 200 com products vazio e total_items 0. Esta rota não responde 404.

Veja também