getProductById

Obtém um objeto de produto único pelo id.

Descrição

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 IProductsEntity.

Produtos.getProductById(

id, langCode

);

Esquema de parâmetros

Esquema

id: number
Id do produto
exemplo: 12345

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

Exemplos

Exemplo mínimo

const response = await Produtos.getProductById(1);

Exemplo com atributos

const response = await Produtos.getProductById(1, 'en_US');

Exemplo de resposta

{
  "id": 2954,
  "localizeInfos": {
    "title": "Caixa"
  },
  "statusIdentifier": "venda",
  "statusLocalizeInfos": {
    "title": "Venda"
  },
  "attributeSetIdentifier": "produtos",
  "position": 1,
  "templateIdentifier": null,
  "shortDescTemplateIdentifier": "product_preview",
  "price": 51,
  "additional": {
    "prices": {
      "min": 51,
      "max": 150
    }
  },
  "sku": null,
  "isSync": true,
  "attributeValues": {
    "product-name": {
      "type": "string",
      "value": "nome-do-produto",
      "isIcon": false,
      "position": 0,
      "additionalFields": [],
      "isProductPreview": false
    },
    "price": {
      "type": "integer",
      "value": 51,
      "isIcon": false,
      "position": 1,
      "additionalFields": [],
      "isProductPreview": false
    },
    "currency_products": {
      "type": "string",
      "value": "usd",
      "isIcon": false,
      "position": 2,
      "additionalFields": [],
      "isProductPreview": false
    },
    "img": {
      "type": "image",
      "value": [],
      "isIcon": false,
      "position": 3,
      "additionalFields": [],
      "isProductPreview": false
    }
  },
  "categories": [
    "catálogo"
  ],
  "isVisible": true,
  "productPages": [
    {
      "id": 2847,
      "pageId": 10,
      "productId": 2954,
      "positionId": 3190,
      "categoryPath": "catálogo"
    }
  ],
  "blocks": [
    "product_block"
  ],
  "moduleFormConfigs": []
}

Esquema de resposta

Esquema: IProductsEntity

id: number
O identificador único.
exemplo: 12345

localizeInfos: ILocalizeInfo
O nome dos produtos, levando em consideração a localização.

statusIdentifier: string | null
Identificadores de status da página do produto (pode ser nulo).
exemplo: "in_stock"

statusLocalizeInfos: any
Descrição JSON do objeto de status do item, levando em consideração o idioma.

attributeSetIdentifier: string | null
Id do conjunto de atributos.
exemplo: "set_12345"

position: number
Número do item (para ordenação).
exemplo: 1

templateIdentifier: string | null
Id do usuário do template vinculado.
exemplo: "template_12345"

shortDescTemplateIdentifier: string | null
Id do usuário do template vinculado para uma descrição curta.
exemplo: "short_desc_template_12345"

price: number
O valor do preço da página do produto retirado do índice.
exemplo: 150

additional: object
Valor adicional do índice.
exemplo:

{
  "en": "Em Estoque",
  "de": "Auf Lager"
}

sku: string | null
SKU do produto (Stock Keeping Unit), pode ser nulo.
exemplo: "SKU_12345"

isSync: boolean
Indicação de indexação da página.
exemplo: true

attributeValues: AttributeType
Array de valores de atributos do índice, representados.
exemplo:

[
  {
    "id": "cor",
    "value": "vermelho"
  }
]

categories: string[]
Categorias de produtos.
exemplo:

[
  1,
  2,
  3
]

isVisible: boolean
Um sinal de visibilidade da página.
exemplo: true

productPages: any[]
Array de páginas de produtos ou um único objeto de página de produto.

blocks: string[]
Array de identificadores de blocos.
exemplo:

[
  "block_12345",
  "block_67890"
]

isPositionLocked: boolean
Indicador de bloqueio da posição de ordenação (opcional).
exemplo: false

relatedIds: number[]
Ids de páginas de produtos relacionadas.
exemplo:

[
  12345,
  67890
]

---