[GET] Variantes y metadatos

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

Descripción general de variantes

El recurso Variantes proporciona información sobre las variantes y sus relaciones con otras entidades, como Productos. Con los metadatos y endpoints descritos aquí, puedes consultar, filtrar y recorrer los datos de variantes de forma eficiente.

Metadatos

Los metadatos son un documento de esquema JSON que describe todos los recursos dentro de la entidad Variantes y sus relaciones con otras entidades. Estos metadatos se pueden usar 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 variantes

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

Cómo hacer una solicitud

Para hacer una solicitud a nuestra API, necesitas usar el método adecuado (GET), la URL del endpoint e incluir la API key en las cabeceras de la solicitud para autenticarte.

Cómo recibir una respuesta

Cuando haces una solicitud a nuestra API, recibirás una respuesta en forma de objeto JSON. Este objeto contendrá los datos solicitados, además de metadatos relevantes como códigos de estado y mensajes de error.

{
  "value": [
    {
      "$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"
        }
      },
      "required": [
        "frmt_ref"
      ]
    }
  ],
  "readLink": {
    "uri": "https://api2.saleslayer.com/rest/Catalog/Variants/$metadata"
  }
}

Consultar variantes

Para recuperar datos de categorías, usa el endpoint de Variantes con los parámetros que necesites.

[GET] Endpoint de variantes

https://api2.saleslayer.com/rest/Catalog/Variants

Cómo hacer una solicitud

Usa el método HTTP: GET.
Incluye la API key en las cabeceras de la solicitud para autenticarte.
Especifica los campos que quieres recuperar con el parámetro $select.

https://api2.saleslayer.com/rest/Catalog/Variants?$top=5&$select=frmt_ref

Cómo recibir una respuesta

{
  "value": [
    {
      "frmt_ref": "F234940"
    },
    {
      "frmt_ref": "F234941"
    },
    {
      "frmt_ref": "F234943"
    },
    {
      "frmt_ref": "F234943 2 - clone"
    },
    {
      "frmt_ref": "F234944"
    }
  ],
  "@count": 80,
  "@readLink": "https://api2.saleslayer.com/rest/Catalog/Variants?$top=5&$select=frmt_ref",
  "@nextLink": "https://api2.saleslayer.com/rest/Catalog/Variants?$top=5&$select=frmt_ref&$skip=5"
}

[GET] Endpoint de variantes de un producto

https://api2.saleslayer.com/rest/Catalog/Products({productIdentifier})/Variants

Cómo hacer una solicitud

Usa el método HTTP: GET.
Incluye la API key en las cabeceras de la solicitud para autenticarte.
Especifica los campos que quieres recuperar con el parámetro $select.
Especifica el producto. Para recuperar las variantes de un producto concreto, incluye el productIdentifier en la URL.

https://api2.saleslayer.com/rest/Catalog/Products(3)/Variants?$select=prod_ref, frmt_ref

Cómo recibir una respuesta

{
  "value": [
    {
      "prod": {
        "reference": "42PH021300412"
      },
      "frmt_ref": "F234946"
    },
    {
      "prod": {
        "reference": "42PH021300412"
      },
      "frmt_ref": "F234952"
    }
  ],
  "@count": 2,
  "@readLink": "https://api2.saleslayer.com/rest/Catalog/Products(3)/Variants?$select=prod_ref, frmt_ref"
}

[GET] Endpoint de un recurso de variante

https://api2.saleslayer.com/rest/Catalog/Variants({variantIdentifier})

Cómo hacer una solicitud

Usa el método HTTP: GET.
Incluye la API key en las cabeceras de la solicitud para autenticarte.
Especifica el variantIdentifier.

https://api2.saleslayer.com/rest/Catalog/Variants(4)?$select=frmt_ref

Cómo recibir una respuesta

Selecciona las propiedades de los recursos de variantes con el parámetro $select disponible en el esquema JSON devuelto por el endpoint /Variants/$metadata y obtén una respuesta.

{
  "value": {
    "frmt_ref": "F234943"
  },
  "@readLink": "https://api2.saleslayer.com/rest/Catalog/Variants(4)?$select=frmt_ref",
  "@editLink": "https://api2.saleslayer.com/rest/Catalog/Variants(4)?$select=frmt_ref"
}

[GET] Endpoint de un recurso de variante asociado a un recurso de producto

https://api2.saleslayer.com/rest/Catalog/Products({productIdentifier})/Variants({variantIdentifier})

Cómo hacer una solicitud

Usa el método HTTP: GET.
Incluye la API key en las cabeceras de la solicitud para autenticarte.
Especifica el variantIdentifier y el productIdentifier.

https://api2.saleslayer.com/rest/Catalog/Products(3)/Variants(48)?$select=frmt_ref,frmt_stat,prod_ref

Cómo recibir una respuesta

Selecciona las propiedades de los recursos de variantes con el parámetro $select disponible en el esquema JSON devuelto por el endpoint /Variants/$metadata y obtén una respuesta.

{
  "value": {
    "frmt_stat": "V",
    "frmt_ref": "F234952",
    "prod": {
      "reference": "42PH021300412"
    }
  },
  "@readLink": "https://api2.saleslayer.com/rest/Catalog/Products(3)/Variants(48)?$select=frmt_ref,frmt_stat,prod_ref",
  "@editLink": "https://api2.saleslayer.com/rest/Catalog/Products(3)/Variants(48)?$select=frmt_ref,frmt_stat,prod_ref"
}

Marcas de tiempo de modificación

Cada entidad de variante incluye:

frmt_creation
frmt_modify

frmt_modify se actualiza cada vez que se modifica la variante.

Sincronización incremental para variantes

Ejemplo:

GET /Variants?$filter=frmt_modify ge 2026-03-01T00:00:00Z

Patrón recomendado:

Guarda la última marca de tiempo procesada.
Usa ge.
Usa frmt_id como identificador único y actualiza los registros existentes en consecuencia.
Usa el formato de fecha y hora UTC.