getRelatedProductsById

Tìm kiếm tất cả các đối tượng sản phẩm liên quan theo id trang.

Mô tả

Phương thức này lấy tất cả các đối tượng trang sản phẩm liên quan cho một sản phẩm cụ thể dựa trên định danh (id) của nó từ API. Nó chấp nhận một tham số userQuery tùy chọn cho các tham số truy vấn bổ sung như offset, limit, sortOrder và sortKey. Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng IProductsResponse.

Products.getRelatedProductsById( id, langCode, userQuery );

Sơ đồ tham số

Sơ đồ

id: number
Định danh trang sản phẩm mà bạn muốn tìm mối quan hệ
ví dụ: 12345

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.templateMarker: string | null
Đánh dấu mẫu trang sản phẩm, mặc định null.
ví dụ: "template_12345"

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

userQuery.conditionValue: string | null
Giá trị mà đ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
Đánh dấu điều kiện lọc mà theo đó các giá trị được lọc, mặc định null.
ví dụ: "equals"

Ví dụ

Ví dụ tối thiểu

const response = await Products.getRelatedProductsById(1);

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

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

const response = await Products.getRelatedProductsById(1, 'en_US', userQuery);

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": "Sản phẩm 1"
  },
  {
    "id": 67890,
    "title": "Sản phẩm 2"
  }
]

---