getICollections

Tüm koleksiyonları alma.

Açıklama

Bir ICollectionEntity nesnesine çözülmekte olan bir Promise döndürür.

IntegrationCollections.getICollections(

langCode, userQuery

);

Parametre şeması

Şema

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

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

{
  "limit": 0,
  "offset": 30,
  "entityType": "orders",
  "entityId": 1
}

Örnekler

Minimal örnek

const result = await IntegrationCollections.getICollections();

Özelliklerle örnek

const userQuery = '';
const result = await IntegrationCollections.getICollections('en_US', userQuery);

Örnek yanıt

[
  {
    "id": 1,
    "identifier": "test_collection",
    "formId": 2,
    "localizeInfos": {
      "title": "test_collection"
    },
    "attributeSetId": null,
    "selectedAttributeMarkers": null
  }
]

Yanıt şeması

Şema: ICollectionEntity[]

id: number
Nesne tanımlayıcısı.
örnek: 1

identifier: string | null
Kayıt alanı için metin tanımlayıcı.
örnek: "collection1"

formId: number | null
Sipariş depolama için kullanılan formun tanımlayıcısı.
örnek: 1234

localizeInfos: ILocalizeInfo
Koleksiyon hakkında yerelleştirilmiş bilgi.
örnek:

{
  "title": "Admins metni"
}

attributeSetId: string | null
Koleksiyona ekli form tarafından kullanılan özellikler setinin tanımlayıcısı.
örnek: "attributeSet1" veya geçerli değilse null

selectedAttributeMarkers: string | null
Veri tablosunda görüntülemek için form nesnesi özelliklerinin metin tanımlayıcıları.
örnek: "collection_marker"

---