Esquemas de dados: Categorias

Esquemas de dados: Categorias. Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

Esquemas de dados

Obter — Categorias — Resposta

ApiResponse_CategoryDetailData_ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataCategoryDetailData Obrigatório: Exemplo de resposta · CategoryDetailData.

Exemplo: {"created_at":"2026-01-01T12:00:00Z","description":"example","id":"example","introduction":"example","is_available":true,"is_visible":false,"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","parent_id":null,"slug":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

Exemplo: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Campos adicionais: Não

Listar — Categorias — Resposta

ApiResponse_list_CategorySummaryData__ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataLista <CategorySummaryData > Obrigatório: Exemplo de resposta · ApiResponse_list_CategorySummaryData__.

Exemplo: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"is_visible":false,"name":"Example","number":"example","parent_id":null,"slug":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

Exemplo: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Campos adicionais: Não

Criar — Categorias — Corpo da requisição

CategoryCreate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

descriptionTexto nullOpcional: Descrição no idioma selecionado.

Texto:maxLength: 50000
introductionTexto nullOpcional: Texto introdutório no idioma selecionado.

Texto:maxLength: 5000
is_visibleBooleanoOpcional: Indica se o recurso é visível.

Predefinido: false
market_idsLista <Texto> Opcional: Identificadores dos mercados selecionados.

maxItems: 1000
Lista:minLength: 1maxLength: 63
meta_descriptionTexto nullOpcional: Descrição para mecanismos de pesquisa no idioma selecionado.

Texto:maxLength: 160
meta_keywordsLista <Texto> nullOpcional: Palavras-chave para mecanismos de pesquisa no idioma selecionado.

Lista:maxItems: 20
Lista / Lista:maxLength: 50
meta_titleTexto nullOpcional: Título para mecanismos de pesquisa no idioma selecionado.

Texto:maxLength: 70
nameTextoObrigatório: Nome do recurso no contexto correspondente.

minLength: 1maxLength: 200

Exemplo: "Example"
parent_idTexto nullOpcional: Identificador da categoria superior.

Texto:minLength: 1maxLength: 63
slugTexto nullOpcional: Segmento do caminho da URL no idioma selecionado.

Texto:maxLength: 160

Campos adicionais: Não

Obter — Categorias — Resposta

CategoryDetailData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

created_atTextoObrigatório: Momento da criação.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"
descriptionTexto nullObrigatório: Descrição no idioma selecionado.

Exemplo: "example"
idTextoObrigatório: Identificador do recurso; preserve-o conforme retornado. (CategoryDetailData).

Exemplo: "example"
introductionTexto nullObrigatório: Texto introdutório no idioma selecionado.

Exemplo: "example"
is_availableBooleanoObrigatório: Indica se o item está disponível neste contexto.

Exemplo: true
is_visibleBooleanoObrigatório: Indica se o recurso é visível.

Exemplo: false
meta_descriptionTexto nullObrigatório: Descrição para mecanismos de pesquisa no idioma selecionado.

Exemplo: "example"
meta_keywordsLista <Texto> nullObrigatório: Palavras-chave para mecanismos de pesquisa no idioma selecionado.

Exemplo: ["example"]
meta_titleTexto nullObrigatório: Título para mecanismos de pesquisa no idioma selecionado.

Exemplo: "example"
nameTexto nullObrigatório: Nome do recurso no contexto correspondente.

Exemplo: "Example"
numberTextoObrigatório: Número do pedido ou da solicitação exibido ao utilizador.

Exemplo: "example"
parent_idTexto nullObrigatório: Identificador da categoria superior.

Exemplo: null
slugTexto nullObrigatório: Segmento do caminho da URL no idioma selecionado.

Exemplo: "example"
updated_atTextoObrigatório: Momento da atualização mais recente.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"
versionNúmero inteiroObrigatório: Versão do recurso utilizada para controlo de concorrência.

Exemplo: 1

Campos adicionais: Não

Listar — Categorias — Resposta

CategorySummaryData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

created_atTextoObrigatório: Momento da criação.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"
idTextoObrigatório: Identificador do recurso; preserve-o conforme retornado. (CategorySummaryData).

Exemplo: "example"
is_availableBooleanoObrigatório: Indica se o item está disponível neste contexto.

Exemplo: true
is_visibleBooleanoObrigatório: Indica se o recurso é visível.

Exemplo: false
nameTexto nullObrigatório: Nome do recurso no contexto correspondente.

Exemplo: "Example"
numberTextoObrigatório: Número do pedido ou da solicitação exibido ao utilizador.

Exemplo: "example"
parent_idTexto nullObrigatório: Identificador da categoria superior.

Exemplo: null
slugTexto nullObrigatório: Segmento do caminho da URL no idioma selecionado.

Exemplo: "example"
updated_atTextoObrigatório: Momento da atualização mais recente.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"
versionNúmero inteiroObrigatório: Versão do recurso utilizada para controlo de concorrência.

Exemplo: 1

Campos adicionais: Não

Atualizar — Categorias — Corpo da requisição

CategoryUpdate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

descriptionTexto nullOpcional: Descrição no idioma selecionado.

Texto:maxLength: 50000
expected_versionNúmero inteiroObrigatório: Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 9223372036854775807

Exemplo: 1
introductionTexto nullOpcional: Texto introdutório no idioma selecionado.

Texto:maxLength: 5000
is_visibleBooleanoOpcional: Indica se o recurso é visível.
market_idsLista <Texto> Opcional: Identificadores dos mercados selecionados.

maxItems: 1000
Lista:minLength: 1maxLength: 63
meta_descriptionTexto nullOpcional: Descrição para mecanismos de pesquisa no idioma selecionado.

Texto:maxLength: 160
meta_keywordsLista <Texto> nullOpcional: Palavras-chave para mecanismos de pesquisa no idioma selecionado.

Lista:maxItems: 20
Lista / Lista:maxLength: 50
meta_titleTexto nullOpcional: Título para mecanismos de pesquisa no idioma selecionado.

Texto:maxLength: 70
nameTexto nullOpcional: Nome do recurso no contexto correspondente.

Texto:maxLength: 200

Exemplo: "Example"
parent_idTexto nullOpcional: Identificador da categoria superior.

Texto:minLength: 1maxLength: 63
slugTexto nullOpcional: Segmento do caminho da URL no idioma selecionado.

Texto:maxLength: 160

Campos adicionais: Não