Pular para o conteúdo principal

getProductById

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

.getProductById(

, ,

);

Esquema de parâmetros​

Esquema

id(obrigatório): número
Id do produto
exemplo: 12345

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

isNormalized: boolean
Se verdadeiro, o objeto do produto será normalizado

Exemplos​

Exemplo mínimo​

const response = await Products.getProductById(1);

Exemplo com atributos​

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

Exemplo de resposta​

{
  "id": 2954,
  "localizeInfos": {
    "title": "Box"
  },
  "isVisible": true,
  "isSync": true,
  "sku": null,
  "price": 51,
  "additional": {
    "prices": {
      "min": 51,
      "max": 180
    }
  },
  "categories": [
    "catalog"
  ],
  "statusIdentifier": "sale",
  "statusLocalizeInfos": {
    "title": "Sale"
  },
  "templateIdentifier": null,
  "shortDescTemplateIdentifier": "product_preview",
  "attributeValues": {
    "product-name": {
      "type": "string",
      "value": "product-name",
      "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": {
        "size": 742690,
        "filename": "files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.jpeg",
        "contentType": "image/jpeg",
        "previewLink": {
          "default": [
            "data:image/webp;base64,UklGRmwAAABXRUJQVlA4IGAAAADQAQCdASoQABAABUB8JbACdACZZ3P8AAD+wGsUXBs/r069WpdrcuaTNfVxqWIetuaIdIvOMkSp9iJRxE+KhA2YHbrVehhMRj/j5+DUdjWn1v5YtZ7vw0IgPi9R5vkAAAA=",
            "https://your-project.oneentry.cloud/cloud-static/files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.preview.default.jpeg"
          ]
        },
        "downloadLink": "https://your-project.oneentry.cloud/cloud-static/files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.jpeg",
        "defaultPreview": "default"
      },
      "isIcon": false,
      "position": 3,
      "additionalFields": {},
      "isProductPreview": true
    }
  },
  "attributeSetIdentifier": "products",
  "isPositionLocked": false,
  "position": 1,
  "rating": {},
  "paymentStages": null,
  "productPages": [
    {
      "id": 2847,
      "pageId": 10,
      "productId": 2954,
      "positionId": 3190,
      "categoryPath": "catalog"
    }
  ],
  "blocks": [
    "product_block",
    "test",
    "similar"
  ],
  "moduleFormConfigs": [
    {
      "id": 12,
      "formIdentifier": "review",
      "moduleIdentifier": "catalog",
      "isGlobal": false,
      "isClosed": false,
      "isModerate": false,
      "viewOnlyMyData": false,
      "commentOnlyMyData": false,
      "entityIdentifiers": [
        {
          "id": "catalog",
          "isNested": true
        }
      ],
      "formDataCount": 807,
      "ratingCalculation": "average",
      "allowHalfRatings": null,
      "maxRatingScale": null,
      "isAnonymous": null,
      "allowRerating": null,
      "isRating": null,
      "entityFormDataCount": {
        "2954": 807
      },
      "nestedEntityIdentifiers": [
        "catalog"
      ],
      "exceptionIds": []
    }
  ],
  "discountConfig": {}
}

Esquema de resposta​

Esquema: IProductsEntity

id: número
O identificador único.
exemplo: 12345

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

{}

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

statusLocalizeInfos: ILocalizeInfo
Nome de status localizado para o produto.
exemplo:

{ "title": "Sale" }

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

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

price: número | null
O valor do preço da página do produto retirado do índice.
exemplo: 150.00

additional: objeto
Valor adicional do índice.
exemplo:

{
  "prices": {
    "min": 5,
    "max": 150
  }
}

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

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

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

[
  {
    "id": "color",
    "value": "red"
  }
]

categories: string[]
Categorias do produto.
exemplo:

[
  1,
  2,
  3
]

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

moduleFormConfigs: Array<IFormConfig>
Configurações de formulário do módulo (opcional).

rating: IRating
Dados de avaliação.

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

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

[
  12345,
  67890
]

paymentStages: desconhecido
Dados das etapas de pagamento (pode ser nulo).
exemplo: nulo

distance: número
Distância de relevância da busca vetorial (semântica). Presente apenas nos resultados da busca vetorial.
exemplo: 0.42

discountConfig: Record<string, unknown>
Objeto de configuração de desconto.
exemplo:

{}

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"

signedPrice: string
O preço assinado do produto é obtido junto com os dados do produto quando signPrice está definido.
veja: Preço fixo do produto
exemplo: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

productPages: IProductPageRef[]
Array de referências de páginas de produtos vinculando o produto às suas páginas.
exemplo:

[
  {
    "id": 16,
    "pageId": 4,
    "productId": 15,
    "positionId": 244,
    "categoryPath": "products"
  }
]

productPages.id: número
Identificador único do registro de link produto-página.
exemplo: 16

productPages.pageId: número
Identificador da página à qual o produto está vinculado.
exemplo: 4

productPages.productId: número
Identificador do produto.
exemplo: 15

productPages.positionId: número
Identificador da posição de ordenação dentro da página.
exemplo: 244

productPages.categoryPath: string
Caminho da categoria da página à qual o produto pertence.
exemplo: "products"

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

[
  "block_12345",
  "block_67890"
]

🔒 signedPrice é o token assinado que carrega o preço bloqueado — passe-o de volta quando você criar um pedido. Veja Preço fixo do produto (signedPrice).

Exemplos de uso​

Passo a passo na documentação:

Experimente ao vivo​

Execute este método interativamente no sandbox do JS SDK — conecte sua URL do Projeto e Token do App na primeira visita, depois abra: