getProductsEmptyPage

Pesquise todos os objetos de produto com paginação que não têm uma categoria.

Descrição

Este método pesquisa objetos de página de produto com paginação que não têm uma categoria, com base nos parâmetros de consulta fornecidos (userQuery). Ele retorna uma Promise que resolve para um objeto IProductsResponse.

Produtos.getProductsEmptyPage( langCode, userQuery );

Esquema de parâmetros

Esquema

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",
  "statusId": 123,
  "statusMarker": "in_stock",
  "conditionValue": "new",
  "conditionMarker": "equals",
  "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.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 pesquisado, 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"

Exemplos

Exemplo mínimo

const response = await Products.getProductsEmptyPage();

Exemplo com atributos

const userQuery = {
  "offset": 0,
  "limit": 30,
  "sortOrder": "DESC",
  "sortKey": "id"
};

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

Exemplo de resposta

{
  "items": [],
  "total": 0
}

Esquema de resposta

Esquema: IProductsResponse

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

items: IProductsEntity[]
Um array de entidades de produto.
exemplo:

[
  {
    "id": 12345,
    "title": "Produto 1"
  },
  {
    "id": 67890,
    "title": "Produto 2"
  }
]

---