getTemplatesPreviewByMarker

Obteniendo un objeto de plantilla por marcador

TemplatePreviews.getTemplatesPreviewByMarker(marker, langCode)

const value = await TemplatePreviews.getTemplatePreviewByMarker('my-marker')

Esquema

marker:* cadena
Marcador del producto
ejemplo: my-marker

langCode: cadena
Parámetro opcional del código de idioma
ejemplo: en_US

Este método recupera un único objeto de plantilla basado en su identificador textual (marcador) de la API. Devuelve una Promesa que se resuelve en un objeto TemplatePreviewsEntity.

Ejemplo de retorno:

{
  "id": 1,
  "version": 0,
  "identifier": "preview-templates",
  "attributeValues": {
    "marker": {
      "value": "",
      "type": "string",
      "position": 1,
      "isProductPreview": false,
      "isIcon": false,
      "attributeFields": {
        "marker": {
          "type": "string",
          "value": "test"
        }
      }
    }
  },
  "attributeSetIdentifier": "my-set",
  "proportion": {
    "vertical": {
      "width": "2",
      "height": "3",
      "alignmentType": "leftTop",
      "marker": "v"
    },
    "horizontal": {
      "width": "234",
      "height": "324",
      "alignmentType": "middleBottom",
      "marker": "h"
    },
    "square": {
      "side": "3",
      "alignmentType": "middleBottom",
      "marker": "s"
    }
  },
  "title": "Plantillas de Vista Previa",
  "position": 1
}

Esquema

id: número
identificador del objeto
ejemplo: 1764

version número
número de versión del objeto de modificación
ejemplo: 10

identifier: cadena
identificador textual para un campo en el registro
ejemplo: catalog

proportion ITemplateProportionType
parámetros de proporción de la plantilla
ejemplo:

{
  "horizontal": {
    "height": 200,
    "weight": 10,
    "marker": "horizontal",
    "title": "Horizontal",
    "alignmentType": "left"
  },
  "vertical": {
    "height": 10,
    "weight": 200,
    "marker": "vertical",
    "title": "Vertical",
    "alignmentType": "left"
  },
  "square": {
    "marker": "square",
    "title": "Cuadrado",
    "slide": 3,
    "alignmentType": "center"
  }
}

title: cadena
nombre de la plantilla
ejemplo: plantilla de página

positionId objeto
número de posición
ejemplo: 0

positionId: número
identificador del objeto de posición
ejemplo: 12