API legada/Referência completa/API 4.0 (app móvel)

Categorias

Devolve a lista de categorias da loja, cada uma com suas subcategorias, e uma categoria isolada.

Use estas rotas para montar o menu de categorias do app. Só entram categorias ativas (situação A); categorias desativadas, ocultas ou na lixeira não aparecem.

A lista é plana: toda categoria, raiz ou filha, é um item. Além disso, cada categoria-pai traz as filhas dentro de subcategories. Por isso uma filha aparece duas vezes: no topo e dentro do pai. Para desenhar só a primeira camada, filtre os itens com parent_id igual a "0".

GET/api/4.0/sra_categoriesPública

Listar categorias

Anônima. Se enviar a ekey do cliente, ela precisa ser válida.

Parâmetros de consulta

parent_category_idstring

Devolve só as filhas diretas desta categoria (id decimal ou UUID). Id desconhecido devolve lista vazia.

company_idstring

Só as categorias que têm produtos deste seller. Aceita vários ids separados por vírgula (company_ids é um sinônimo). Ids desconhecidos são ignorados; se nenhum for válido, a lista vem vazia. As categorias-pai das que casaram também ficam na lista.

pageintegerpadrão: 1

Página, a partir de 1. Só vale com items_per_page.

items_per_pageinteger

Itens por página. Sem este parâmetro a lista inteira vem de uma vez e params.items_per_page é 0. (per_page é aceito como sinônimo.)

GET/api/4.0/sra_categories/{id}Pública

Ler uma categoria

Devolve uma categoria com as filhas aninhadas em subcategories. Categoria inexistente ou inativa responde 404.

Parâmetros de caminho

idstringobrigatório

Id da categoria (decimal ou UUID).

Exemplo de requisição

bash

curl "$BASE_URL/api/4.0/sra_categories?parent_category_id=2126275725"

Resposta

200Categorias retornadas

json

{
  "categories": [
    {
      "category": "Notebooks",
      "category_id": "779063179",
      "parent_id": "2126275725",
      "position": "0",
      "product_count": "162",
      "seo_name": "notebooks",
      "status": "A",
      "subcategories": []
    },
    {
      "category": "Mouses",
      "category_id": "981937052",
      "parent_id": "2126275725",
      "position": "1",
      "product_count": "319",
      "seo_name": "mouses",
      "status": "A",
      "subcategories": []
    }
  ],
  "params": { "items_per_page": 0, "page": 1, "total_items": 2 }
}

Campos da resposta

categories[].categorystring

Nome da categoria.

categories[].category_idstring

Id decimal da categoria.

categories[].parent_idstring

Id da categoria-pai. "0" é uma categoria raiz.

categories[].positionstring

Ordem entre irmãs, como texto.

categories[].product_countstring

Quantidade de produtos da categoria que a vitrine mostra, como texto. A loja pode exigir preço e estoque para contar um produto.

categories[].seo_namestring

Slug usado no endereço público.

categories[].statusstring

Sempre A nesta rota.

categories[].subcategoriesarray

Filhas diretas, com os mesmos campos. Vazio quando não há.

paramsobject

page, items_per_page (0 quando sem paginação) e total_items (todas as categorias que atendem ao filtro).

A leitura de uma categoria (/sra_categories/{id}) devolve o objeto da categoria direto, sem categories nem params.

Erros

Status	Quando	Corpo
401	Cabeçalho `Authorization` presente mas inválido	`{"error":"unauthorized"}`
404	Categoria inexistente ou inativa	`{"error":"category not found"}`
500	Falha ao ler as categorias	`{"error":"failed to list categories"}`

Veja também