API atual/Referência completa/Categorias do seller

Exportar categorias e ficha técnica

Baixa as categorias do seller em CSV e lê a ficha de características exigidas para os produtos de uma categoria.

Duas consultas de apoio ao cadastro de produtos. A ficha técnica diz quais atributos preencher em Características do produto para o produto ter boa qualidade de catálogo.

Exportar categorias

Baixa em CSV (;, UTF-8 com BOM) as categorias dos seus produtos e as liberadas para você, da raiz para as folhas. Serve para conferir a árvore e para montar planilhas de importação com os id certos.

GET/api/v1/vendor/categories/exportSeller

Exportar categorias em CSV

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Exemplo de requisição (exportar)

bash

curl "$BASE_URL/api/v1/vendor/categories/export" \
  -H "Authorization: Bearer $TOKEN"

Resposta (exportar)

200Arquivo CSV

text

id;name;parent_id;slug;description;status;position;meta_title;meta_keywords
345ac33e-4dcd-4d60-bedf-a2c2d47897d9;Roupas;;roupas;;A;0;;
5e4d3c2b-0001-4a1b-9c2d-3e4f5a6b7c8d;Camisetas;345ac33e-4dcd-4d60-bedf-a2c2d47897d9;camisetas;Camisetas básicas;A;0;;

Campos da resposta

(cabeçalho)text/csv

Arquivo categorias.csv com as colunas id, name, parent_id, slug, description, status, position, meta_title, meta_keywords.

Erros (exportar)

Status	Quando	Corpo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	Token que não é de seller, ou usuário sem o privilégio exigido pela rota.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog"]}`
500	Falha ao montar o arquivo.	`{"error":"export categories failed","detail":"..."}`

Ficha técnica

Devolve quais características a loja exige (required) ou recomenda (recommended) nos produtos de uma categoria. Se a categoria não tem ficha própria, vale a da ancestral mais próxima, indicada em inherited_from.

GET/api/v1/vendor/categories/{id}/feature-templateSeller

Ler a ficha técnica da categoria

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

idstring (uuid)obrigatório

Id da categoria.

Exemplo de requisição (ficha)

bash

curl "$BASE_URL/api/v1/vendor/categories/$CATEGORY_ID/feature-template" \
  -H "Authorization: Bearer $TOKEN"

Resposta (ficha)

200Ficha técnica

json

{
  "items": [
    {
      "feature_id": "1f2e3d4c-5b6a-4789-8a9b-0c1d2e3f4a5b",
      "feature_name": "Material",
      "requirement": "required",
      "position": 0
    },
    {
      "feature_id": "2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d",
      "feature_name": "Cor",
      "requirement": "recommended",
      "position": 1
    }
  ],
  "inherited_from": null
}

Campos da resposta

itemsarray

Características da ficha: feature_id, feature_name, requirement (required ou recommended), position.

inherited_fromstring (uuid) | null

Categoria ancestral de onde a ficha foi herdada; null quando é da própria categoria ou não há ficha.

Erros (ficha)

Status	Quando	Corpo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	Token que não é de seller, ou usuário sem o privilégio exigido pela rota.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog"]}`
500	Falha ao consultar.	`{"error":"failed","detail":"..."}`

Veja também

Categorias do seller: visão geral

API atual/Referência completa/Categorias do seller

Exportar categorias e ficha técnica

Baixa as categorias do seller em CSV e lê a ficha de características exigidas para os produtos de uma categoria.

Duas consultas de apoio ao cadastro de produtos. A ficha técnica diz quais atributos preencher em Características do produto para o produto ter boa qualidade de catálogo.

Exportar categorias

GET/api/v1/vendor/categories/exportSeller

Exportar categorias em CSV

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Exemplo de requisição (exportar)

bash

curl "$BASE_URL/api/v1/vendor/categories/export" \
  -H "Authorization: Bearer $TOKEN"

Resposta (exportar)

200Arquivo CSV

text

id;name;parent_id;slug;description;status;position;meta_title;meta_keywords
345ac33e-4dcd-4d60-bedf-a2c2d47897d9;Roupas;;roupas;;A;0;;
5e4d3c2b-0001-4a1b-9c2d-3e4f5a6b7c8d;Camisetas;345ac33e-4dcd-4d60-bedf-a2c2d47897d9;camisetas;Camisetas básicas;A;0;;

Campos da resposta

(cabeçalho)text/csv

Arquivo categorias.csv com as colunas id, name, parent_id, slug, description, status, position, meta_title, meta_keywords.

Erros (exportar)

Status	Quando	Corpo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	Token que não é de seller, ou usuário sem o privilégio exigido pela rota.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog"]}`
500	Falha ao montar o arquivo.	`{"error":"export categories failed","detail":"..."}`

Ficha técnica

GET/api/v1/vendor/categories/{id}/feature-templateSeller

Ler a ficha técnica da categoria

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

idstring (uuid)obrigatório

Id da categoria.

Exemplo de requisição (ficha)

bash

curl "$BASE_URL/api/v1/vendor/categories/$CATEGORY_ID/feature-template" \
  -H "Authorization: Bearer $TOKEN"

Resposta (ficha)

200Ficha técnica

json

{
  "items": [
    {
      "feature_id": "1f2e3d4c-5b6a-4789-8a9b-0c1d2e3f4a5b",
      "feature_name": "Material",
      "requirement": "required",
      "position": 0
    },
    {
      "feature_id": "2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d",
      "feature_name": "Cor",
      "requirement": "recommended",
      "position": 1
    }
  ],
  "inherited_from": null
}

Campos da resposta

itemsarray

Características da ficha: feature_id, feature_name, requirement (required ou recommended), position.

inherited_fromstring (uuid) | null

Categoria ancestral de onde a ficha foi herdada; null quando é da própria categoria ou não há ficha.

Erros (ficha)

Status	Quando	Corpo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	Token que não é de seller, ou usuário sem o privilégio exigido pela rota.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog"]}`
500	Falha ao consultar.	`{"error":"failed","detail":"..."}`

Veja também

Categorias do seller: visão geral