getProductsEmptyPage

Kategorisi olmayan tüm ürün nesnelerini sayfalama ile arayın.

Açıklama

Bu yöntem, sağlanan sorgu parametrelerine (userQuery) dayanarak kategorisi olmayan ürün sayfası nesnelerini sayfalama ile arar. Bir Promise döner ve bu Promise, IProductsResponse nesnesine çözülür.

Products.getProductsEmptyPage( langCode, userQuery );

Parametreler şeması

Şema

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

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

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

userQuery.offset(gerekli): number
Sayfalama için parametre. Varsayılan: 0.

userQuery.limit(gerekli): number
Sayfalama için parametre. Varsayılan: 30.

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

userQuery.sortKey(gerekli): 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"

Varsayılan olarak, 10 nesne alabilirsiniz. Bu, modülün izin ayarlarında kayıt limitinden kaynaklanmaktadır.
Sayfalamanın doğru çalışması için, ilgili bölümde ihtiyaçlarınıza göre Modül izinlerini yapılandırmanız gerekir.

Örnekler

Minimal örnek

const response = await Products.getProductsEmptyPage();

Nitelikler ile örnek

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

const response = await Products.getProductsEmptyPage('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"
  }
]

---