getProductsPriceByPageUrl

Pesquise informações sobre produtos e preços para a categoria selecionada.

Descrição

Este método busca informações sobre produtos e preços para a categoria selecionada, com base nos parâmetros de consulta fornecidos (userQuery). Ele retorna uma Promise que resolve para um objeto IProductsInfo.

Products.getProductsPriceByPageUrl( url, langCode, userQuery );

Esquema de parâmetros

Esquema

url: string
URL da página
exemplo: "23-laminat-floorwood-maxima"

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

userQuery: IProductsQuery
Conjunto de parâmetros de consulta opcionais
exemplo:

{
  "limit": 30,
  "offset": 0,
  "sortOrder": "DESC",
  "sortKey": "id",
  "signPrice": "orders",
  "templateMarker": "template_12345",
  "statusMarker": "in_stock",
  "conditionValue": "new",
  "conditionMarker": "eq",
  "attributeMarker": "color"
}

userQuery.offset(obrigatório): number
Parâmetro para paginação. Padrão: 0.

userQuery.limit(obrigatório): number
Parâmetro para paginação. Padrão: 30.

userQuery.sortOrder(obrigatório): string
Ordem de classificação "DESC" | "ASC". Padrão: "DESC".

userQuery.sortKey(obrigatório): string
Campo para classificação (padrão - null). Valores possíveis: "id", "position", "title", "date", "price". Padrão: null.

userQuery.signPrice: string
Símbolo do preço. Padrão: null.

userQuery.templateMarker: string | null
Marcador de template da página do produto, padrão null.
exemplo: "template_12345"

userQuery.statusMarker: string | null
Marcador de status da página do produto, padrão null.
exemplo: "in_stock"

userQuery.conditionValue: string | null
O valor que está sendo buscado, padrão null.
exemplo: "new"

userQuery.attributeMarker: string | null
O identificador de texto do atributo indexado pelo qual os valores são filtrados, padrão null.
exemplo: "color"

userQuery.conditionMarker: string | null
Marcador da condição de filtro pela qual os valores são filtrados, padrão null.
exemplo: "equals"

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

userQuery.ids: string
Lista de ids de produtos separados por vírgula — usada por getProductsByIds.
exemplo: "1,2,3"

Por padrão, você pode recuperar 10 objetos. Isso se deve ao limite de registro nas configurações de permissões do módulo.
Para que a paginação funcione corretamente, você precisa configurar as Permissões do módulo de acordo com suas necessidades na seção correspondente.

Exemplos

Exemplo mínimo

const response = await Products.getProductsPriceByPageUrl('catalog');

Exemplo com atributos

const userQuery = {
  "offset": 0,
  "limit": 30,
  "statusMarker": "in_stock",
  "conditionValue": "new",
  "conditionMarker": "equals",
  "attributeMarker": "color",
  "sortOrder": "DESC",
  "sortKey": "id",
};

const response = await Products.getProductsPriceByPageUrl('catalog', 'en_US', userQuery);

Use filtros para encontrar produtos específicos:

attributeMarker: O identificador de texto do atributo indexado pelo qual os valores são filtrados. conditionMarker: O tipo de condição a ser aplicada ao valor do atributo.

Marcador	Significado	Exemplo
eq	Igual	statusId = 1 (apenas ativo)
neq	Não igual	role ≠ "Viewer"
in	Contém (um dos)	role in ["Editor", "Manager"]
nin	Não contém	email not in ["@temp.com"]
exs	Existe (tem valor)	Tem lastLogin
nexs	Não existe	Nunca fez login

conditionValue: O valor a ser comparado.

Exemplo de resposta

{
  "items": [
    {
      "id": 2957,
      "price": 150
    },
    {
      "id": 2954,
      "price": 51
    },
    {
      "id": 2955,
      "price": 0
    }
  ],
  "total": 3
}

Esquema de resposta

Esquema: IProductsInfo

total: number
O número total de produtos encontrados.
exemplo: 100

items: IProductInfo[]
Um array de objetos de informações do produto.
exemplo:

[
  {
    "id": 12345,
    "price": 150
  },
  {
    "id": 67890,
    "price": 200
  }
]

items.id: number
O identificador único do produto.
exemplo: 12345

items.price: number
O preço do produto.
exemplo: 150

---