getRelatedProductsById

Sayfa kimliğine göre tüm ilgili ürün nesnelerini arayın

Products.getRelatedProductsById(id, langCode, userQuery)

const value = await Products.getRelatedProductsById(1)

Şema

id:* number
İlişki bulmak için ürün sayfası tanımlayıcısı
örnek:

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

userQuery: IProductsQuery
İsteğe bağlı sorgu parametreleri
örnek: []

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
Sıralamak için isteğe bağlı alan (id, title, date, price, position, status)
örnek: id

Bu yöntem, API'den belirli bir ürünün tanımlayıcısına (id) dayalı olarak tüm ilgili ürün sayfası nesnelerini alır. Offset, limit, sortOrder ve sortKey gibi ek sorgu parametreleri için isteğe bağlı bir userQuery parametresi kabul eder. Bir dizi nesneye çözülen bir Promise döner.

Örnek dönüş:

{
  "total": 100,
  "items": [
    {
      "id": 2,
      "localizeInfos": {
        "title": "Kutu"
      },
      "statusIdentifier": "satıldı",
      "statusLocalizeInfos": {
        "title": "Satıldı"
      },
      "attributeSetIdentifier": "ürünler",
      "position": 3,
      "templateIdentifier": null,
      "isPositionLocked": false,
      "shortDescTemplateIdentifier": null,
      "price": 148,
      "additional": {
        "prices": {
          "min": 120,
          "max": 150
        }
      },
      "sku": null,
      "isSync": true,
      "attributeValues": {
        "price": {
          "type": "integer",
          "value": 148,
          "position": 1,
          "isProductPreview": false
        },
        "product-name": {
          "type": "string",
          "value": "Kutu metni",
          "position": 0,
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "$",
          "position": 2,
          "isProductPreview": false
        }
      },
      "isVisible": true,
      "isPositionLocked": false
    }

  ]
}

Şema

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

id: number
Nesne tanımlayıcısı
örnek: 1764

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

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

statusLocalizeInfos: CommonLocalizeInfos
Dilin dikkate alındığı nesne durumu nesnesinin json tanımı
örnek:

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

localizeInfos: Record<string, any>
Dilin dikkate alındığı ana sayfa veri nesnesinin json tanımı "en_US" (ö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
özellik 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 özellik değerleri dizisi (özel özellik tanımlayıcısı: özellik değeri çifti olarak sunulur)
ö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