getProducts

Tüm ürün nesnelerini sayfalama ve filtre ile arayın

Products.getProducts(body, langCode, userQuery)

const body = [
  {
    "attributeMarker": "price",
    "conditionMarker": "mth",
    "statusMarker": "waiting",
    "conditionValue": 1,
    "pageUrls": [
      "23-laminat-floorwood-maxima"
    ],
    "isNested": false,
    "title": ""
  },
  {
    "attributeMarker": "price",
    "conditionMarker": "lth",
    "conditionValue": 3,
    "pageUrls": [
      "23-laminat-floorwood-maxima"
    ],
    "isNested": false,
    "title": ""
  }
]

const value = await Products.getProducts(body)

Şema

body:* IFilterParams[]
İstek gövdesi. Varsayılan [].
örnek: []

langCode: string
Dil kodu parametresi. Varsayılan "en_US"
örnek: en_US

userQuery: IProductsQuery
İsteğe bağlı sorgu parametreleri.

userQuery.offset: number
Sayfalama için isteğe bağlı parametre, varsayılan 0'dır
örnek: 0

userQuery.limit: number
Sayfalama için isteğe bağlı parametre, varsayılan 30'dur
örnek: 30

userQuery.sortOrder: string
İsteğe bağlı sıralama düzeni DESC | ASC
örnek: DESC

userQuery.sortKey: string
İsteğe bağlı sıralama için alan (id, title, date, price, position, status)
örnek: id

userQuery.statusId: number
İsteğe bağlı parametre - durum kimliğine göre arama
örnek: 1

userQuery.statusMarker: string
Ürün sayfası durumunun isteğe bağlı tanımlayıcısı
örnek: waiting

userQuery.conditionValue: string
Aranan isteğe bağlı değer
örnek: 3

userQuery.conditionMarker: string
Değerlerin filtrelendiği filtre koşulunun isteğe bağlı tanımlayıcısı
örnek: mth

userQuery.attributeMarker: string
Değerlerin filtrelendiği dizinlenmiş niteliğin isteğe bağlı metin tanımlayıcısı
örnek: price

Şema (body)

attributeMarker: string
niteliğin metinsel tanımlayıcısı
örnek: price

conditionMarker: string
koşulun metinsel tanımlayıcısı
örnek: in

statusMarker: string
ürün sayfası durumunun metinsel tanımlayıcısı (varsayılan ayarlanmamış)
örnek: status_1

conditionValue: number
koşul değeri
örnek: 1

pageUrls: Array<string>
sayfa URL'sinin benzersiz kısmı (son "/"'dan sonra)

title: string
örnek: Iphone 17 Pro
ürün adı

isNested: boolean
tüm iç içe kategoriler için arama göstergesi (pageUrls)
örnek: false

Bu yöntem, sağlanan sorgu parametrelerine (userQuery) dayanarak kategoriye sahip olmayan tüm ürün nesnelerini sayfalama ile arar. Her bir öğenin bir nesne olduğu bir dizi öğe döndüren bir Promise döner.

Örnek dönüş:

{
  "total": 100,
  "items": [
    {
      "id": 4,
      "localizeInfos": {
        "title": "Cosmo"
      },
      "statusIdentifier": null,
      "statusLocalizeInfos": {},
      "attributeSetIdentifier": "products",
      "position": 1,
      "templateIdentifier": null,
      "isPositionLocked": false,
      "shortDescTemplateIdentifier": null,
      "price": 150,
      "additional": {
        "prices": {
          "min": 120,
          "max": 150
        }
      },
      "sku": null,
      "isSync": true,
      "attributeValues": {
        "price": {
          "type": "integer",
          "value": 150,
          "position": 1,
          "isProductPreview": false
        },
        "product-name": {
          "type": "string",
          "value": "Cosmo",
          "position": 0,
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "",
          "position": 2,
          "isProductPreview": false
        }
      },
      "isVisible": true
    }
  ]
}

Şema

total: number
bulunan kayıtların toplam sayısı
örnek: 100

id: number
n nesne tanımlayıcısı
örnek: 1764

additional: Record<string, any>
indeksten ek değer
örnek:

{
  "prices": {
    "min": 0,
    "max": 100
  }
}

statusLocalizeInfos: CommonLocalizeInfos
öğe durum nesnesinin dil dikkate alınarak json tanımı
örnek:

{ "title": "Ürün" }

localizeInfos: Record<string, any>
dil "en_US" dikkate alınarak ana sayfa veri nesnesinin json tanımı (örneğin)
örnek:

{
  "en_US": {
    "title": "Katalog",
    "plainContent": "Katalog için içerik",
    "htmlContent": "<b>Katalog için içerik</b>",
    "menuTitle": "Katalog"
  }
}

isVisible: boolean
Sayfa görünürlük bayrağı
örnek: true

position: number
sıralama için pozisyon numarası
örnek: 192

templateIdentifier: string
ilişkili şablonun özel tanımlayıcısı
örnek: my-template

attributeSetId: number
nitelik seti tanımlayıcısı
örnek: 7

blocks: array
ürün blokları
örnek:

["product_block"]

isSync: boolean
sayfa indeksleme göstergesi (true veya false)
örnek: false

attributeValues: Record<string, string>
indeksten gelen nitelik değerleri dizisi (özel nitelik tanımlayıcısı: nitelik değeri çifti olarak sunulmuştur)
örnek:

{
  "en_US": {
    "marker": {
      "value": "",
      "type": "string"
    }
  }
}

statusId: number
ürün sayfasının durum tanımlayıcıları (null olabilir)
örnek: 1

sku: string
indeksten alınan ürün SKU değeri
örnek: 1

relatedIds: array
ilişkili ürün sayfalarının tanımlayıcıları
örnek:

[ 1, 2, 3 ]

price: number
indeksten alınan ürün sayfasının fiyat değeri
örnek: 0

templateIdentifier string
ilişkili şablonun özel tanımlayıcısı
örnek: my-template

shortDescTemplateIdentifier string
kısa açıklama için ilişkili şablonun özel tanımlayıcısı
örnek: my-template-short