getICollections

Mengambil semua koleksi.

Deskripsi

Ini mengembalikan sebuah Promise yang menyelesaikan menjadi objek ICollectionEntity.

IntegrationCollections.getICollections(

langCode, userQuery

);

Skema parameter

Skema

langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"

userQuery: object
Parameter kueri yang dapat diatur secara opsional
contoh:

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

Contoh

Contoh minimal

const result = await IntegrationCollections.getICollections();

Contoh dengan atribut

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

Contoh respons

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

Skema respons

Skema: ICollectionEntity[]

id: number
Identifikasi objek.
contoh: 1

identifier: string | null
Identifikasi teks untuk field catatan.
contoh: "collection1"

formId: number | null
Identifikasi untuk formulir yang digunakan oleh penyimpanan pesanan.
contoh: 1234

localizeInfos: ILocalizeInfo
Informasi terlokalisasi tentang koleksi.
contoh:

{
  "title": "Admins text"
}

attributeSetId: number | null
Identifikasi dari set atribut yang digunakan oleh formulir yang terlampir pada koleksi.
contoh: 1234 atau null jika tidak berlaku

selectedAttributeMarkers: string | null
Identifikasi teks dari atribut objek formulir untuk ditampilkan di tabel data.
contoh: "collection_marker"

---