getProductById

Obtenha um objeto de produto pelo id

Products.getProductById(id, langCode)

const value = await Products.getProductById(1)

Esquema

id:* Id do produto

• Id do produto*
  exemplo: 1
  

langCode:
Parâmetro do código de idioma. Padrão "en_US"
exemplo: en_US

Este método recupera um único objeto de produto com base em seu identificador (id) da API. Ele retorna uma Promise que resolve para um objeto do produto.

Exemplo de retorno:

{
  "id": 3,
  "localizeInfos": {
    "title": "Produto"
  },
  "statusIdentifier": null,
  "statusLocalizeInfos": {},
  "attributeSetIdentifier": "products",
  "position": 1,
  "templateIdentifier": null,
  "shortDescTemplateIdentifier": null,
  "price": 120,
  "additional": {
    "prices": {
      "min": 120,
      "max": 150
    }
  },
  "sku": null,
  "isSync": true,
  "attributeValues": {
    "price": {
      "type": "integer",
      "value": "120",
      "position": 1,
      "isProductPreview": false
    },
    "product-name": {
      "type": "string",
      "value": "Prod",
      "position": 0,
      "isProductPreview": false
    },
    "currency_products": {
      "type": "string",
      "value": "$",
      "position": 2,
      "isProductPreview": false
    }
  },
  "isVisible": true,
  "productPages": {
    "id": 3,
    "pageId": 2,
    "productId": 3,
    "positionId": 215
  },
  "blocks": [
    "product_block",
    "another"
  ]
}

Esquema

id: número
identificador do objeto
exemplo: 1764

additional: Record<string, any>
valor adicional do índice
exemplo:

{
  "prices": {
    "min": 0,
    "max": 100
  }
}

statusLocalizeInfos: CommonLocalizeInfos
descrição em json do objeto de status do item, levando em conta o idioma
exemplo:

{ "title": "Produto" }

localizeInfos: Record<string, any>
descrição em json do objeto de dados da página principal levando em conta o idioma "en_US" (por exemplo)
exemplo:

{
  "en_US": {
    "title": "Catálogo",
    "plainContent": "Conteúdo para catálogo",
    "htmlContent": "<b>Conteúdo para catálogo</b>",
    "menuTitle": "Catálogo"
  }
}

isVisible: booleano
Flag de visibilidade da página
exemplo: true

position: número
número de posição (para ordenação)
exemplo: 192

templateIdentifier: string
identificador personalizado do template associado
exemplo: my-template

attributeSetId: número
identificador do conjunto de atributos
exemplo: 7

blocks: array
blocos de produto
exemplo: ['product_block']

isSync: booleano
indicador de indexação da página (true ou false)
exemplo: false

attributeValues: Record<string, string>
Array de valores de atributos do índice (apresentado como um par de identificador de atributo personalizado: valor do atributo)
exemplo:

{
  "en_US": {
    "marker": {
      "value": "",
      "type": "string"
    }
  }
}

statusId: número
identificadores de status da página do produto (pode ser nulo)
exemplo: 1

sku: string
valor SKU do produto retirado do índice
exemplo: 1

relatedIds: array
identificadores das páginas de produtos relacionados
exemplo:

[ 1, 2, 3 ]

price: número
valor do preço da página do produto retirado do índice
exemplo: 0

templateIdentifier string
identificador personalizado do template associado
exemplo: my-template

shortDescTemplateIdentifier string
identificador personalizado do template associado para descrição curta
exemplo: my-template-short