API legada/Referência completa/Catálogo do app do vendedor

GETCategorias do app

Lista as categorias do catálogo para o app do seller escolher onde classificar um produto.

Devolve as categorias da loja no formato do app do seller, para ele mostrar a lista de onde classificar um produto. É a árvore da loja, achatada (use parent_id para reconstruí-la), sem contagem de produtos.

GET/api/v1.0/vendor_categoriesSeller

Listar as categorias

A rota não tem parâmetros de consulta: não filtra nem pagina.

Cabeçalhos

Authorizationstringobrigatório

Basic base64(e-mail:chave_de_api) ou Bearer $TOKEN do usuário de um seller ativo.

GET/api/vendor_categoriesSeller

Alias de GET /api/v1.0/vendor_categories

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/vendor_categories. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

GET/api/v1.0/vn_categories_apiSeller

Alias de GET /api/v1.0/vendor_categories

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/vendor_categories.

GET/api/vn_categories_apiSeller

Alias de GET /api/v1.0/vendor_categories

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/vendor_categories. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/vendor_categories"

Resposta

200Categorias

json

{
  "status": 200,
  "data": {
    "success": true,
    "message": "",
    "categories": [
      {
        "category_id": "8fcaf422-1631-4282-b503-85cc57380649",
        "category_name": "Camisetas",
        "parent_id": "5239a365-7ca5-4fd3-8d8f-aea92b7dfe3a",
        "status": "A",
        "position": 0
      }
    ]
  }
}

Campos da resposta

statusinteger

Sempre 200: o status HTTP real é o da conexão.

data.successboolean

true se a lista foi lida.

data.messagestring

Vazio no sucesso. No erro, o motivo (Failed to load categories).

data.categories[].category_iduuid

Id da categoria. Na URL sem v1.0, um inteiro derivado do UUID.

data.categories[].category_namestring

Nome da categoria.

data.categories[].parent_iduuid|null

Categoria pai. Vazio na raiz.

data.categories[].statusstring

Status da categoria. Como só as ativas são listadas, vem A.

data.categories[].positioninteger

Ordem entre irmãs.

Erros

Status	Quando	Corpo
200	Conta que não é de seller ativo	`{"status": 200, "data": {"success": false, "message": "User is not a vendor", "action": "logout"}}`
200	Falha ao ler as categorias	`{"status": 200, "data": {"success": false, "message": "Failed to load categories"}}`
401	Sem credencial ou credencial inválida	`{"message": "Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.", "status": 401}`
403	Usuário que é cliente, não seller nem administrador	`{"message": "Forbidden: vendor scope required", "status": 403}`

Veja também

GETCategorias do app

Lista as categorias do catálogo para o app do seller escolher onde classificar um produto.

GET/api/v1.0/vendor_categoriesSeller

Listar as categorias

A rota não tem parâmetros de consulta: não filtra nem pagina.

Cabeçalhos

Authorizationstringobrigatório

Basic base64(e-mail:chave_de_api) ou Bearer $TOKEN do usuário de um seller ativo.

GET/api/vendor_categoriesSeller

Alias de GET /api/v1.0/vendor_categories

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/vendor_categories. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

GET/api/v1.0/vn_categories_apiSeller

Alias de GET /api/v1.0/vendor_categories

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/vendor_categories.

GET/api/vn_categories_apiSeller

Alias de GET /api/v1.0/vendor_categories

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/vendor_categories. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/vendor_categories"

Resposta

200Categorias

json

{
  "status": 200,
  "data": {
    "success": true,
    "message": "",
    "categories": [
      {
        "category_id": "8fcaf422-1631-4282-b503-85cc57380649",
        "category_name": "Camisetas",
        "parent_id": "5239a365-7ca5-4fd3-8d8f-aea92b7dfe3a",
        "status": "A",
        "position": 0
      }
    ]
  }
}

Campos da resposta

statusinteger

Sempre 200: o status HTTP real é o da conexão.

data.successboolean

true se a lista foi lida.

data.messagestring

Vazio no sucesso. No erro, o motivo (Failed to load categories).

data.categories[].category_iduuid

Id da categoria. Na URL sem v1.0, um inteiro derivado do UUID.

data.categories[].category_namestring

Nome da categoria.

data.categories[].parent_iduuid|null

Categoria pai. Vazio na raiz.

data.categories[].statusstring

Status da categoria. Como só as ativas são listadas, vem A.

data.categories[].positioninteger

Ordem entre irmãs.

Erros

Status	Quando	Corpo
200	Conta que não é de seller ativo	`{"status": 200, "data": {"success": false, "message": "User is not a vendor", "action": "logout"}}`
200	Falha ao ler as categorias	`{"status": 200, "data": {"success": false, "message": "Failed to load categories"}}`
401	Sem credencial ou credencial inválida	`{"message": "Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.", "status": 401}`
403	Usuário que é cliente, não seller nem administrador	`{"message": "Forbidden: vendor scope required", "status": 403}`