Pular para o conteúdo principal

getProductById

Obtém um objeto de produto pelo id.

Produtos?.getProductById( id?, langCode? );

Exemplo mínimo

const value = await Products.getProductById(1)
Esquema

id: número
Id do produto
exemplo: 12345

langCode: string
Código do 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 resposta

{
"id": 2954,
"localizeInfos": {
"title": "Caixa"
},
"statusIdentifier": "venda",
"statusLocalizeInfos": {
"title": "Venda"
},
"attributeSetIdentifier": "produtos",
"position": 1,
"templateIdentifier": null,
"shortDescTemplateIdentifier": "product_preview",
"price": 50,
"additional": {
"prices": {
"min": 50,
"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": 50,
"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": [
"bloco_produto"
]
}
Esquema

id: número
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: "em_estoque"

statusLocalizeInfos: qualquer
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: número
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: número
O valor do preço da página do produto retirado do índice.
exemplo: 150

additional: objeto
Valor adicional do índice.

sku: string | null
SKU do produto (Unidade de Manutenção de Estoque), pode ser nulo.
exemplo: "SKU_12345"

isSync: booleano
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 do produto.
exemplo:

[
1,
2,
3
]

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

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

blocks: string[]
Array de identificadores de blocos.

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

relatedIds: número[]
Ids de páginas de produtos relacionadas.
exemplo:

[
12345,
67890
]