getICollections

Lấy tất cả các bộ sưu tập.

Mô tả

Hàm này trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng ICollectionEntity.

IntegrationCollections.getICollections(

langCode, userQuery

);

Sơ đồ tham số

Sơ đồ

langCode: string
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"

userQuery: object
Tham số truy vấn tùy chọn
ví dụ:

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

Ví dụ

Ví dụ tối thiểu

const result = await IntegrationCollections.getICollections();

Ví dụ với các thuộc tính

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

Ví dụ phản hồi

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

Sơ đồ phản hồi

Sơ đồ: ICollectionEntity[]

id: number
Định danh đối tượng.
ví dụ: 1

identifier: string | null
Định danh văn bản cho trường bản ghi.
ví dụ: "collection1"

formId: number | null
Định danh cho biểu mẫu được sử dụng bởi kho lưu trữ đơn hàng.
ví dụ: 1234

localizeInfos: ILocalizeInfo
Thông tin địa phương hóa về bộ sưu tập.
ví dụ:

{
  "title": "Admins text"
}

attributeSetId: string | null
Định danh của bộ thuộc tính được sử dụng bởi biểu mẫu gắn với bộ sưu tập.
ví dụ: "attributeSet1" hoặc null nếu không áp dụng

selectedAttributeMarkers: string | null
Định danh văn bản của các thuộc tính đối tượng biểu mẫu để hiển thị trong bảng dữ liệu.
ví dụ: "collection_marker"

---