getRelatedProductsById

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

Açıklama

Bu yöntem, belirli bir ürün için API'den tanımlayıcısına (id) dayalı olarak tüm ilgili ürün sayfası nesnelerini alır. Ek sorgu parametreleri için isteğe bağlı bir userQuery parametresi kabul eder; bu parametreler arasında offset, limit, sortOrder ve sortKey bulunur. Bir Promise döner ve bu Promise, IProductsResponse nesnesi ile çözülür.

Products.getRelatedProductsById( id, langCode, userQuery );

Parametreler şeması

Şema

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

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

userQuery: IProductsQuery
İsteğe bağlı sorgu parametrelerini ayarlayın
örnek:

{
  "limit": 30,
  "offset": 0,
  "sortOrder": "DESC",
  "sortKey": "id",
  "statusId": 123,
  "statusMarker": "in_stock",
  "conditionValue": "new",
  "conditionMarker": "equals",
  "attributeMarker": "color"
}

userQuery.offset(required): number
Sayfalandırma için parametre. Varsayılan: 0.

userQuery.limit(required): number
Sayfalandırma için parametre. Varsayılan: 30.

userQuery.sortOrder(required): string
Sıralama düzeni "DESC" | "ASC". Varsayılan: "DESC".

userQuery.sortKey(required): string
Sıralama için alan (varsayılan - null). Olası değerler: "id", "position", "title", "date", "price". Varsayılan: null.

userQuery.templateMarker: string | null
Ürün sayfası şablon işareti, varsayılan null.
örnek: "template_12345"

userQuery.statusMarker: string | null
Ürün sayfası durum işareti, varsayılan null.
örnek: "in_stock"

userQuery.conditionValue: string | null
Aranan değer, varsayılan null.
örnek: "new"

userQuery.attributeMarker: string | null
Değerlerin filtrelendiği dizinlenmiş niteliğin metin tanımlayıcısı, varsayılan null.
örnek: "color"

userQuery.conditionMarker: string | null
Değerlerin filtrelendiği filtre koşulunun işareti, varsayılan null.
örnek: "equals"

Örnekler

Minimal örnek

const response = await Products.getRelatedProductsById(1);

Nitelikler ile örnek

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

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

Örnek yanıt

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

Yanıt şeması

Şema: IProductsResponse

total: number
Bulunan toplam ürün sayısı.
örnek: 100

items: IProductsEntity[]
Ürün varlıklarının bir dizisi.
örnek:

[
  {
    "id": 12345,
    "title": "Ürün 1"
  },
  {
    "id": 67890,
    "title": "Ürün 2"
  }
]

---