Descripción general de categorías
El recurso Categories proporciona información sobre las categorías de producto y sus relaciones con otras entidades, como Productos y Variantes. Con los metadatos y endpoints descritos aquí, puedes consultar, filtrar y recorrer los datos de categorías de forma eficiente.
Metadatos
Los metadata son un documento JSON Schema que describe todos los recursos dentro de la entidad Categories y sus relaciones con otras entidades. Estos metadatos pueden usarse para construir consultas para la API y para entender la estructura de las entidades relacionadas.
Detalles clave sobre los metadatos
- Cuando solicitas los metadatos de una tabla, también recibes los metadatos de sus tablas relacionadas, por ejemplo Productos y Variantes.
- Los metadatos son esenciales para entender qué campos se pueden consultar y expandir.
[GET] Endpoint de metadatos de Categories
https://api2.saleslayer.com/rest/Catalog/Categories/$metadata
Hacer una solicitud
Para hacer una solicitud a nuestra API, tendrás que usar el método adecuado (GET), la URL del endpoint e incluir la API key en las cabeceras de la solicitud para la autenticación.
Recibir una respuesta
Cuando hagas una solicitud a nuestra API, recibirás una respuesta en forma de objeto JSON. Este objeto contendrá los datos solicitados, junto con metadatos relevantes como códigos de estado y mensajes de error.
{
"value": [
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "/metadata/9587/Category/1.0.0.0",
"type": "object",
"title": "Category",
"description": "Category metadata definition",
"default": {
"culture": "en"
},
"properties": {
"cat_ref": {
"title": "Category Reference",
"type": "string"
},
"cat_title": {
"title": "Category name",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"culture": {
"type": "string",
"enum": [
"de",
"en",
"en-us",
"es",
"fr"
],
"default": "en"
},
"value": {
"type": "string"
}
},
"required": [
"culture"
]
}
},
"cat_parent_ref": {
"title": "Parent Category Reference",
"type": [
"string",
"null"
]
},
"Products": {
"type": [
"array",
"null"
],
"items": {
"$ref": "/metadata/9587/Product/1.0.0.0"
}
}
},
"required": [
"cat_ref"
]
},
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "/metadata/9587/Product/1.0.0.0",
"type": "object",
"title": "Product",
"description": "Product metadata definition",
"default": {
"culture": "en"
},
"properties": {
"prod_ref": {
"title": "prod_ref",
"type": [
"string",
"null"
]
},
"prod_title": {
"title": "prod_name",
"type": "array",
"items": {
"type": "object",
"properties": {
"culture": {
"type": "string",
"enum": [
"de",
"en",
"en-us",
"es",
"fr"
],
"default": "en"
},
"value": {
"type": "string"
}
},
"required": [
"culture"
]
}
},
"cat_ref": {
"title": "Category Reference",
"type": [
"string",
"null"
]
},
"Variants": {
"type": [
"array",
"null"
],
"items": {
"$ref": "/metadata/9587/Variant/1.0.0.0"
}
},
"AttributeSets": {
"type": [
"array",
"null"
],
"items": {
"$ref": "/metadata/9587/AttributeSet/1.0.0.0"
}
}
},
"required": [
"prod_title"
]
},
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "/metadata/9587/Variant/1.0.0.0",
"type": "object",
"title": "Variant",
"description": "Variant metadata definition",
"default": {
"culture": "en"
},
"properties": {
"frmt_stat": {
"title": "Status",
"type": [
"string",
"null"
],
"enum": [
"V",
"I",
"D",
"R"
],
"default": "R"
},
"prod_ref": {
"title": "var_prod_ref",
"type": [
"string",
"null"
]
},
"frmt_ref": {
"title": "Variant Reference",
"type": "string"
},
"frmt_tags": {
"title": "Tags",
"type": [
"string",
"null"
]
}
},
"required": [
"frmt_ref"
]
}
],
"readLink": {
"uri": "https://api2.saleslayer.com/rest/Catalog/Categories/$metadata?=cat_ref,cat_title,cat_description,cat_parent_ref,cat_image,cat_image1,cat_file,cat_shorttext,cat_longtext,cat_number,cat_bool,cat_listofattributes,cat_weblink,cat_date,cat_relateditems,cat_table"
}
}Consultar categorías
Para recuperar datos de categorías, utiliza el endpoint de Categories con los parámetros que necesites.
[GET] Endpoint de Categories
https://api2.saleslayer.com/rest/Catalog/Categories
Hacer una solicitud
- Usa el método HTTP: GET.
- Incluye la API key en las cabeceras de la solicitud para la autenticación.
- Especifica los campos que quieres recuperar con el parámetro
$select.
http://api2.saleslayer.com/rest/Catalog/Categories?$select=cat_id,cat_title
Recibir una respuesta
Cuando hagas una solicitud a nuestra API, recibirás una respuesta en forma de objeto JSON. Este objeto contendrá los datos solicitados, junto con metadatos relevantes como códigos de estado y mensajes de error.
{
"value": [
{
"cat_id": 2,
"cat_title": {
"es": "Mujer"
}
},
{
"cat_id": 3,
"cat_title": {
"es": "Verano"
}
},
{
"cat_id": 4,
"cat_title": {
"es": "Camisas"
}
},
{
"cat_id": 5,
"cat_title": {
"es": "Camisetas"
}
},
{
"cat_id": 6,
"cat_title": {
"es": "Invierno"
}
}
],
"@count": 16,
"@readLink": "https://api2.saleslayer.com/rest/Catalog/Categories?$top=5&$select=cat_id,cat_title",
"@nextLink": "https://api2.saleslayer.com/rest/Catalog/Categories?$top=5&$select=cat_id,cat_title&$skip=5"
}[GET] Endpoint de un recurso Category
https://api2.saleslayer.com/rest/Catalog/Categories({categoryIdentifier})Hacer una solicitud
- Usa el método HTTP: GET.
- Incluye la API key en las cabeceras de la solicitud para la autenticación.
- Especifica los campos que quieres recuperar con el parámetro
$select - Indica el valor de categoryIdentifier
https://api2.saleslayer.com/rest/Catalog/Categories(6)?$select=cat_title,cat_parent_ref
Recibir una respuesta
Selecciona las propiedades del recurso Category con el parámetro $select, disponible en el JSON Schema devuelto por el endpoint /Categories/$metadata, y obtén la respuesta.
{
"value": {
"cat_title": {
"es": "Invierno"
},
"cat_parent_ref": "MUJERref01"
},
"@readLink": "https://api2.saleslayer.com/rest/Catalog/Categories(6)?$select=cat_title,cat_parent_ref",
"@editLink": "https://api2.saleslayer.com/rest/Catalog/Categories(6)?$select=cat_title,cat_parent_ref"
}Marcas de tiempo de modificación
Cada Category incluye:
cat_creationcat_modify
cat_modify se actualiza automáticamente cada vez que se modifica la categoría.
Sincronización incremental para categorías
GET /Categories?$filter=cat_modify ge 2026-03-01T00:00:00Z
Patrón recomendado:
- Guarda la última marca de tiempo procesada.
- Usa
ge. - Usa
cat_idcomo identificador único. - Trata las marcas de tiempo como UTC.
¿Le ha sido útil este artículo?
¡Qué bien!
Gracias por sus comentarios
¡Sentimos mucho no haber sido de ayuda!
Gracias por sus comentarios
Sus comentarios se han enviado
Agradecemos su esfuerzo e intentaremos corregir el artículo