Esquemas de datos: Categorías

Esquemas de datos: Categorías. Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

Esquemas de datos

Obtener — Categorías — Respuesta

ApiResponse_CategoryDetailData_ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataCategoryDetailData Obligatorio: Ejemplo de respuesta · CategoryDetailData.

Ejemplo: {"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 Obligatorio: Metadatos de la respuesta.

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

Campos adicionales: No

Listar — Categorías — Respuesta

ApiResponse_list_CategorySummaryData__ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataLista <CategorySummaryData > Obligatorio: Ejemplo de respuesta · ApiResponse_list_CategorySummaryData__.

Ejemplo: [{"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 Obligatorio: Metadatos de la respuesta.

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

Campos adicionales: No

Crear — Categorías — Cuerpo de la solicitud

CategoryCreate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

descriptionCadena de texto nullOpcional: Descripción en el idioma seleccionado.

Cadena de texto:maxLength: 50000
introductionCadena de texto nullOpcional: Texto introductorio en el idioma seleccionado.

Cadena de texto:maxLength: 5000
is_visibleBooleanoOpcional: Indica si el recurso es visible.

Valor predeterminado: false
market_idsLista <Cadena de texto> Opcional: Identificadores de los mercados seleccionados.

maxItems: 1000
Lista:minLength: 1maxLength: 63
meta_descriptionCadena de texto nullOpcional: Descripción para buscadores en el idioma seleccionado.

Cadena de texto:maxLength: 160
meta_keywordsLista <Cadena de texto> nullOpcional: Palabras clave para buscadores en el idioma seleccionado.

Lista:maxItems: 20
Lista / Lista:maxLength: 50
meta_titleCadena de texto nullOpcional: Título para buscadores en el idioma seleccionado.

Cadena de texto:maxLength: 70
nameCadena de textoObligatorio: Nombre del recurso en el contexto correspondiente.

minLength: 1maxLength: 200

Ejemplo: "Example"
parent_idCadena de texto nullOpcional: Identificador de la categoría superior.

Cadena de texto:minLength: 1maxLength: 63
slugCadena de texto nullOpcional: Segmento de la ruta URL en el idioma seleccionado.

Cadena de texto:maxLength: 160

Campos adicionales: No

Obtener — Categorías — Respuesta

CategoryDetailData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

created_atCadena de textoObligatorio: Momento de creación.

format: "date-time"

Ejemplo: "2026-01-01T12:00:00Z"
descriptionCadena de texto nullObligatorio: Descripción en el idioma seleccionado.

Ejemplo: "example"
idCadena de textoObligatorio: Identificador del recurso; consérvalo tal como se devuelve. (CategoryDetailData).

Ejemplo: "example"
introductionCadena de texto nullObligatorio: Texto introductorio en el idioma seleccionado.

Ejemplo: "example"
is_availableBooleanoObligatorio: Indica si el elemento está disponible en este contexto.

Ejemplo: true
is_visibleBooleanoObligatorio: Indica si el recurso es visible.

Ejemplo: false
meta_descriptionCadena de texto nullObligatorio: Descripción para buscadores en el idioma seleccionado.

Ejemplo: "example"
meta_keywordsLista <Cadena de texto> nullObligatorio: Palabras clave para buscadores en el idioma seleccionado.

Ejemplo: ["example"]
meta_titleCadena de texto nullObligatorio: Título para buscadores en el idioma seleccionado.

Ejemplo: "example"
nameCadena de texto nullObligatorio: Nombre del recurso en el contexto correspondiente.

Ejemplo: "Example"
numberCadena de textoObligatorio: Número de pedido o solicitud mostrado al usuario.

Ejemplo: "example"
parent_idCadena de texto nullObligatorio: Identificador de la categoría superior.

Ejemplo: null
slugCadena de texto nullObligatorio: Segmento de la ruta URL en el idioma seleccionado.

Ejemplo: "example"
updated_atCadena de textoObligatorio: Momento de la última actualización.

format: "date-time"

Ejemplo: "2026-01-01T12:00:00Z"
versionNúmero enteroObligatorio: Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

Campos adicionales: No

Listar — Categorías — Respuesta

CategorySummaryData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

created_atCadena de textoObligatorio: Momento de creación.

format: "date-time"

Ejemplo: "2026-01-01T12:00:00Z"
idCadena de textoObligatorio: Identificador del recurso; consérvalo tal como se devuelve. (CategorySummaryData).

Ejemplo: "example"
is_availableBooleanoObligatorio: Indica si el elemento está disponible en este contexto.

Ejemplo: true
is_visibleBooleanoObligatorio: Indica si el recurso es visible.

Ejemplo: false
nameCadena de texto nullObligatorio: Nombre del recurso en el contexto correspondiente.

Ejemplo: "Example"
numberCadena de textoObligatorio: Número de pedido o solicitud mostrado al usuario.

Ejemplo: "example"
parent_idCadena de texto nullObligatorio: Identificador de la categoría superior.

Ejemplo: null
slugCadena de texto nullObligatorio: Segmento de la ruta URL en el idioma seleccionado.

Ejemplo: "example"
updated_atCadena de textoObligatorio: Momento de la última actualización.

format: "date-time"

Ejemplo: "2026-01-01T12:00:00Z"
versionNúmero enteroObligatorio: Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

Campos adicionales: No

Actualizar — Categorías — Cuerpo de la solicitud

CategoryUpdate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

descriptionCadena de texto nullOpcional: Descripción en el idioma seleccionado.

Cadena de texto:maxLength: 50000
expected_versionNúmero enteroObligatorio: Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 1maximum: 9223372036854775807

Ejemplo: 1
introductionCadena de texto nullOpcional: Texto introductorio en el idioma seleccionado.

Cadena de texto:maxLength: 5000
is_visibleBooleanoOpcional: Indica si el recurso es visible.
market_idsLista <Cadena de texto> Opcional: Identificadores de los mercados seleccionados.

maxItems: 1000
Lista:minLength: 1maxLength: 63
meta_descriptionCadena de texto nullOpcional: Descripción para buscadores en el idioma seleccionado.

Cadena de texto:maxLength: 160
meta_keywordsLista <Cadena de texto> nullOpcional: Palabras clave para buscadores en el idioma seleccionado.

Lista:maxItems: 20
Lista / Lista:maxLength: 50
meta_titleCadena de texto nullOpcional: Título para buscadores en el idioma seleccionado.

Cadena de texto:maxLength: 70
nameCadena de texto nullOpcional: Nombre del recurso en el contexto correspondiente.

Cadena de texto:maxLength: 200

Ejemplo: "Example"
parent_idCadena de texto nullOpcional: Identificador de la categoría superior.

Cadena de texto:minLength: 1maxLength: 63
slugCadena de texto nullOpcional: Segmento de la ruta URL en el idioma seleccionado.

Cadena de texto:maxLength: 160

Campos adicionales: No