Nhảy đến nội dung

getICollectionRowsById

Lấy tất cả các bản ghi thuộc về bộ sưu tập theo id của 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 ICollectionRowsResponce.

IntegrationCollections.getICollectionRowsById(

id*, langCode, userQuery

);

Sơ đồ tham số

Sơ đồ

id(bắt buộc): số
Id của bộ sưu tập
ví dụ: 1

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

userQuery: bất kỳ
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.getICollectionRowsById(1);

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

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

Ví dụ phản hồi

{
"items": [
{
"id": 1,
"entityId": null,
"entityType": null,
"createdDate": "2025-02-25T07:05:52.627Z",
"updatedDate": "2025-02-25T07:05:52.627Z",
"formData": [
{
"marker": "naimenovanie_1",
"type": "string",
"value": "Наименование"
}
],
"attributeSetIdentifier": null
},
{
"id": 2,
"entityId": null,
"entityType": null,
"createdDate": "2025-02-25T07:05:53.057Z",
"updatedDate": "2025-02-25T07:05:53.057Z",
"formData": [
{
"marker": "naimenovanie_1",
"type": "string",
"value": "Наименование"
}
],
"attributeSetIdentifier": null
},
{
"id": 3,
"entityId": null,
"entityType": null,
"createdDate": "2025-02-25T07:05:54.003Z",
"updatedDate": "2025-02-25T07:05:54.460Z",
"formData": [
{
"marker": "naimenovanie_1",
"type": "string",
"value": "Наименование 2"
}
],
"attributeSetIdentifier": null
},
"..."
],
"total": 214
}

Sơ đồ phản hồi

Sơ đồ: ICollectionRowsResponce

items: ICollectionRow[]
Mảng các đối tượng hàng trong bộ sưu tập.
ví dụ:

[
{
"id": 1,
"createdDate": "2025-06-06T19:08:54.616Z",
"updatedDate": "2025-06-06T19:08:54.616Z",
"entityId": null,
"entityType": null,
"formData": [
{
"marker": "name_1",
"type": "string",
"value": "Value"
}
],
"attributeSetIdentifier": null
}
]

items.id: số
Định danh của đối tượng.
ví dụ: 1

items.createdDate: chuỗi
Ngày tạo bản ghi.
ví dụ: "2023-01-01T00:00:00Z"

items.updatedDate: chuỗi
Ngày cập nhật cuối cùng của bản ghi.
ví dụ: "2023-01-02T00:00:00Z"

items.collectionId: số | null
collectionId liên kết với hàng trong bộ sưu tập.
ví dụ: "product", "order", "v.v."

items.formData: ICollectionFormData[]
Mảng các đối tượng dữ liệu biểu mẫu liên kết với hàng trong bộ sưu tập.
ví dụ:

[
{
"marker": "name_1",
"type": "string",
"value": "Value"
}
]

formData.marker: chuỗi
Định danh văn bản (marker) của trường biểu mẫu.
ví dụ: "collection_marker"

formData.type: chuỗi
Loại của trường biểu mẫu, chẳng hạn như "text", "number", "date", "v.v."
ví dụ: "number"

formData.value: chuỗi
Giá trị của trường biểu mẫu, có thể là "string", "number", "date", "v.v."
ví dụ: "Collection marker"

items.entityType: chuỗi | null
Loại của thực thể liên kết với hàng trong bộ sưu tập.
ví dụ: "product", "order", "v.v."

items.entityId: số | null
Định danh của thực thể liên kết với hàng trong bộ sưu tập.
ví dụ: 12345

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

items.total: chuỗi
Tổng số lượng.
ví dụ: "1"

total: số
Tổng số bản ghi đã tìm thấy.
ví dụ: 10