[GET] Entidades personalizadas (material de venta) y metadatos

Modificado el Mie, 6 May a 12:19 P. M.

Descripción general de entidades personalizadas

El recurso de Entidades personalizadas proporciona información sobre tablas que no corresponden estrictamente a información de producto y sobre sus relaciones con otras entidades, como Productos y Variantes. Con los metadatos y endpoints descritos aquí, puedes consultar, filtrar y recorrer los datos de entidades personalizadas de forma eficiente.

NOTA: las Entidades personalizadas se llamaban anteriormente material de venta.

Metadatos

Los metadatos son un documento de esquema JSON que describe todos los recursos dentro de la entidad Entidades personalizadas y sus relaciones con otras entidades. Estos metadatos pueden utilizarse para construir consultas para la API y para comprender la estructura de las entidades relacionadas.

Detalles clave sobre los metadatos

Al solicitar los metadatos de una tabla, también recibirás los metadatos de sus tablas relacionadas (por ejemplo,).
Los metadatos son esenciales para entender qué campos se pueden consultar y expandir.

Endpoint [GET] de metadatos de entidades personalizadas

https://api2.saleslayer.com/rest/Catalog/CustomEntities/$metadata

Realizar una solicitud

Para realizar una solicitud a nuestra API, necesitarás 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 realices una solicitud a nuestra API, recibirás una respuesta en forma de objeto JSON. Este objeto contendrá los datos solicitados, así como cualquier metadato relevante, como códigos de estado y mensajes de error.

{
  "value": [
    {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "$id": "/metadata/10650/CustomEntity('Clothing accessories')/1.0.0.0",
      "type": "object",
      "title": "CustomEntities('Clothing accessories')",
      "description": "CustomEntities('Clothing accessories') context metadata definition",
      "default": {
        "culture": "es"
      },
      "properties": {
        "acfk_id": {
          "title": "acfk_id",
          "type": "integer",
          "minimum": 0,
          "maximum": 18446744073709552000
        },
        "acfk_ref": {
          "title": "Referencia",
          "type": [
            "string",
            "null"
          ],
          "x-custom-type": "reference"
        },
        "acfk_stat": {
          "title": "Estatus",
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "V",
            "I",
            "D",
            "R"
          ],
          "default": "R"
        },
        "acfk_title": {
          "title": "Nombre",
          "type": "string"
        },
        "acfk_image": {
          "title": "Imagen",
          "type": "object",
          "properties": {
            "information": {
              "type": "string"
            },
            "reference": {
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "Vd",
                "Up",
                "Ok",
                "Re",
                "Er",
                "Dv"
              ]
            },
            "modifiedOn": {
              "type": "string",
              "format": "date-time"
            }
          },
          "x-custom-type": "image_pack"
        },
        "acfk_modify": {
          "title": "acfk_modify",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "acfk_creation": {
          "title": "acfk_creation",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "acfk_tags": {
          "title": "Etiquetas",
          "type": [
            "string",
            "null"
          ]
        },
        "acfk_bundleproduct": {
          "title": "Bundle-Product",
          "type": [
            "string",
            "null"
          ],
          "x-custom-type": "link_items"
        }
      },
      "required": [
        "acfk_title",
        "acfk_id"
      ],
      "x-storage-object-name": "mat_tabla_comercial_prueba",
      "x-storage-object-identifier-attribute": "acfk_id",
      "x-storage-object-status-attribute": "acfk_stat",
      "x-storage-object-reference-attribute": "acfk_ref"
    }
  ],
  "readLink": {
    "uri": "https://api2.saleslayer.com/rest/Catalog/CustomEntities/$metadata"
  }
}

Endpoint [GET] de metadatos de una entidad personalizada concreta

https://api2.saleslayer.com/rest/Catalog/CustomEntities('{customEntityDenominator}')/$metadata

Realizar una solicitud

Usa el método HTTP: GET.
Incluye la API key en las cabeceras de la solicitud para la autenticación.
Especifica customEntityDenominator. El denominador es el nombre en lenguaje natural con el que se creó la entidad personalizada en el PIM.

https://api2.saleslayer.com/rest/Catalog/CustomEntities('Ironing-products')/$metadata

Recibir una respuesta

{
  "value": [
    {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "$id": "/metadata/10650/CustomEntity('Ironing-products')/1.0.0.0",
      "type": "object",
      "title": "CustomEntities('Ironing-products')",
      "description": "CustomEntities('Ironing-products') context metadata definition",
      "default": {
        "culture": "es"
      },
      "properties": {
        "stwu_id": {
          "title": "stwu_id",
          "type": "integer",
          "minimum": 0,
          "maximum": 18446744073709552000
        },
        "stwu_ref": {
          "title": "Referencia",
          "type": [
            "string",
            "null"
          ],
          "x-custom-type": "reference"
        },
        "stwu_stat": {
          "title": "Estatus",
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "V",
            "I",
            "D",
            "R"
          ],
          "default": "R"
        },
        "stwu_title": {
          "title": "Nombre",
          "type": "string"
        },
        "stwu_image": {
          "title": "Imagen",
          "type": "object",
          "properties": {
            "information": {
              "type": "string"
            },
            "reference": {
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "Vd",
                "Up",
                "Ok",
                "Re",
                "Er",
                "Dv"
              ]
            },
            "modifiedOn": {
              "type": "string",
              "format": "date-time"
            }
          },
          "x-custom-type": "image_pack"
        },
        "stwu_modify": {
          "title": "stwu_modify",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "stwu_creation": {
          "title": "stwu_creation",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "stwu_tags": {
          "title": "Etiquetas",
          "type": [
            "string",
            "null"
          ]
        },
        "stwu_bundleplanchado": {
          "title": "Bundle-Planchado",
          "type": [
            "string",
            "null"
          ],
          "x-custom-type": "link_items"
        }
      },
      "required": [
        "stwu_title",
        "stwu_id"
      ],
      "x-storage-object-name": "mat_ironing_products",
      "x-storage-object-identifier-attribute": "stwu_id",
      "x-storage-object-status-attribute": "stwu_stat",
      "x-storage-object-reference-attribute": "stwu_ref"
    }
  ],
  "readLink": {
    "uri": "https://api2.saleslayer.com/rest/Catalog/CustomEntities('Ironing-products')/$metadata"
  }
}

Consultar entidades personalizadas

Para recuperar datos de categorías, utiliza Entidades personalizadas con los parámetros deseados.

Endpoint [GET] de un recurso de entidad personalizada

https://api2.saleslayer.com/rest/Catalog/CustomEntities('{customEntityDenominator}')

Realizar 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 usando el parámetro $select.
Especifica customEntityDenominator. El denominador es el nombre en lenguaje natural con el que se creó la entidad personalizada en el PIM.

https://api2.saleslayer.com/rest/Catalog/CustomEntities('Ironing-products')?$select=stwu_id, stwu_bundleplanchado,stwu_tags

Recibir una respuesta

{
  "value": [
    {
      "stwu_id": 1,
      "stwu_bundleplanchado": "42PM026320361",
      "stwu_tags": "CamisaSeda"
    },
    {
      "stwu_id": 2,
      "stwu_bundleplanchado": "42PH201100693,42PM213705071",
      "stwu_tags": "toda-tela"
    }
  ],
  "@count": 2,
  "@readLink": "https://api2.saleslayer.com/rest/Catalog/CustomEntities('Ironing-products')?$select=stwu_id, stwu_bundleplanchado,stwu_tags"
}

Marcas de tiempo de modificación

Cada entidad personalizada incluye:

Un campo de fecha de creación
Un campo de fecha de modificación

El campo de modificación se actualiza cada vez que se modifica la entidad.

Sincronización incremental para entidades personalizadas

GET /CustomEntities?$filter=entity_modify ge 2026-03-01T00:00:00Z

Patrón recomendado:

Guarda la última marca de tiempo procesada.
Usa ge.
Usa el ID de la entidad como identificador único.
Usa formato UTC.

Comportamiento de modificación de assets (entidades personalizadas)

Los campos de tipo imagen o archivo devuelven objetos estructurados como image_pack o file_pack.

Estos objetos incluyen:

reference: nombre original del archivo
information: metadatos y recortes de imagen configurados
status: estado de procesamiento
modifiedOn: última fecha de modificación del campo asset

Cuando un campo de imagen o archivo se modifica a través de la API:

Se actualiza el valor de modifiedOn a nivel de campo.
También se actualiza la marca de tiempo de modificación de la entidad principal.

La API no genera dinámicamente resoluciones de imagen arbitrarias. Solo están disponibles los recortes configurados.