Nhảy đến nội dung

getProductsEmptyPage

Tìm kiếm tất cả các đối tượng sản phẩm với phân trang mà không có danh mục.

Mô tả

Phương thức này tìm kiếm các đối tượng trang sản phẩm với phân trang mà không có danh mục, dựa trên các tham số truy vấn được cung cấp (userQuery). Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng IProductsResponse.

Products.getProductsEmptyPage( langCode, userQuery );

Sơ đồ tham số

Sơ đồ

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

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

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

userQuery.offset(bắt buộc): number
Tham số cho phân trang. Mặc định: 0.

userQuery.limit(bắt buộc): number
Tham số cho phân trang. Mặc định: 30.

userQuery.sortOrder(bắt buộc): string
Thứ tự sắp xếp "DESC" | "ASC". Mặc định: "DESC".

userQuery.sortKey(bắt buộc): string
Trường để sắp xếp (mặc định - null). Các giá trị có thể: "id", "position", "title", "date", "price". Mặc định: null.

userQuery.signPrice: string
Dấu giá. Mặc định: null.

userQuery.templateMarker: string | null
Dấu hiệu mẫu trang sản phẩm, mặc định null.
ví dụ: "template_12345"

userQuery.statusMarker: string | null
Dấu hiệu trạng thái trang sản phẩm, mặc định null.
ví dụ: "in_stock"

userQuery.conditionValue: string | null
Giá trị đang được tìm kiếm, mặc định null.
ví dụ: "new"

userQuery.attributeMarker: string | null
Định danh văn bản của thuộc tính đã được lập chỉ mục mà theo đó các giá trị được lọc, mặc định null.
ví dụ: "color"

userQuery.conditionMarker: string | null
Dấu hiệu của điều kiện lọc mà theo đó các giá trị được lọc, mặc định null.
ví dụ: "equals"

Mặc định, bạn có thể lấy 10 đối tượng. Điều này là do giới hạn số bản ghi trong cài đặt quyền của module.
Để phân trang hoạt động chính xác, bạn cần cấu hình Quyền module theo nhu cầu của bạn trong phần tương ứng.

Ví dụ

Ví dụ tối thiểu

const response = await Products.getProductsEmptyPage();

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

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

const response = await Products.getProductsEmptyPage('en_US', userQuery);
Sử dụng bộ lọc để tìm các sản phẩm cụ thể:

attributeMarker: Định danh văn bản của thuộc tính đã được lập chỉ mục mà theo đó các giá trị được lọc. conditionMarker: Loại điều kiện áp dụng cho giá trị thuộc tính.

Dấu hiệuÝ nghĩaVí dụ
eqBằngstatusId = 1 (chỉ hoạt động)
neqKhông bằngrole ≠ "Viewer"
inChứa (một trong số)role in ["Editor", "Manager"]
ninKhông chứaemail not in ["@temp.com"]
exsTồn tại (có giá trị)Có lastLogin
nexsKhông tồn tạiChưa bao giờ đăng nhập

conditionValue: Giá trị để so sánh.

Ví dụ phản hồi

{
"items": [],
"total": 0
}

Sơ đồ phản hồi

Sơ đồ: IProductsResponse

total: number
Tổng số sản phẩm được tìm thấy.
ví dụ: 100

items: IProductsEntity[]
Mảng các thực thể sản phẩm.
ví dụ:

[
{
"id": 12345,
"title": "Product 1"
},
{
"id": 67890,
"title": "Product 2"
}
]

items.id: number
Định danh duy nhất.
ví dụ: 12345

items.localizeInfos: ILocalizeInfo
Tên của các sản phẩm, tính đến việc địa phương hóa.
ví dụ:

items.statusIdentifier: string | null
Định danh trạng thái trang sản phẩm (có thể là null).
ví dụ: "in_stock"

items.statusLocalizeInfos: Record<string, any>
Mô tả JSON của đối tượng trạng thái, tính đến ngôn ngữ.
ví dụ:

items.attributeSetIdentifier: string | null
Tập hợp các id thuộc tính.
ví dụ: "set_12345"

items.position: number
Số thứ tự của mục (để sắp xếp).
ví dụ: 1

items.price: number | null
Giá trị của giá trang sản phẩm lấy từ chỉ mục.
ví dụ: 150.00

items.additional: object
Giá trị bổ sung từ chỉ mục.
ví dụ:

{
"en": "In Stock",
"de": "Auf Lager"
}

items.sku: string | null
SKU sản phẩm (Đơn vị lưu kho), có thể là null.
ví dụ: "SKU_12345"

items.isSync: boolean
Chỉ báo về việc lập chỉ mục trang.
ví dụ: true

items.attributeValues: AttributeType
Mảng các giá trị thuộc tính từ chỉ mục, được biểu diễn.
ví dụ:

[
{
"id": "color",
"value": "red"
}
]

items.categories: string[]
Danh mục sản phẩm.
ví dụ:

[
1,
2,
3
]

items.isVisible: boolean
Dấu hiệu về tính khả dụng của trang.
ví dụ: true

items.moduleFormConfigs: Array<IFormConfig>
Cấu hình biểu mẫu module (tùy chọn).

items.isPositionLocked: boolean
Chỉ báo khóa vị trí sắp xếp (tùy chọn).
ví dụ: false

items.relatedIds: number[]
Cac id của các trang sản phẩm liên quan.
ví dụ:

[
12345,
67890
]

items.templateIdentifier: string | null
Id người dùng của mẫu liên kết.
ví dụ: "template_12345"

items.shortDescTemplateIdentifier: string | null
Id người dùng của mẫu liên kết cho mô tả ngắn.
ví dụ: "short_desc_template_12345"

items.signedPrice: string
Dấu giá.

items.productPages: Array<Record<string, any>> | Record<string, any>
Mảng các trang sản phẩm hoặc một đối tượng trang sản phẩm đơn lẻ.
ví dụ: []

items.blocks: string[]
Mảng các định danh khối.
ví dụ:

[
"block_12345",
"block_67890"
]