getRelatedProductsById

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

Products.getRelatedProductsById(id, langCode, userQuery)

const value = await Products.getRelatedProductsById(1)

Schema

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

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

userQuery: IProductsQuery
Các tham số truy vấn tùy chọn
ví dụ: []

userQuery.offset: số
Tham số tùy chọn cho phân trang, mặc định là 0
ví dụ: 0

userQuery.limit: số
Tham số tùy chọn cho phân trang, mặc định là 30
ví dụ: 30

userQuery.sortOrder: chuỗi
Thứ tự sắp xếp tùy chọn DESC | ASC
ví dụ: DESC

userQuery.sortKey: chuỗi
Trường tùy chọn để sắp xếp (id, title, date, price, position, status)
ví dụ: id

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 của nó (id) 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 mảng các đối tượng.

Ví dụ trả về:

{
  "total": 100,
  "items": [
    {
      "id": 2,
      "localizeInfos": {
        "title": "Hộp"
      },
      "statusIdentifier": "sold",
      "statusLocalizeInfos": {
        "title": "Đã bán"
      },
      "attributeSetIdentifier": "products",
      "position": 3,
      "templateIdentifier": null,
      "isPositionLocked": false,
      "shortDescTemplateIdentifier": null,
      "price": 148,
      "additional": {
        "prices": {
          "min": 120,
          "max": 150
        }
      },
      "sku": null,
      "isSync": true,
      "attributeValues": {
        "price": {
          "type": "integer",
          "value": 148,
          "position": 1,
          "isProductPreview": false
        },
        "product-name": {
          "type": "string",
          "value": "Nội dung hộp",
          "position": 0,
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "$",
          "position": 2,
          "isProductPreview": false
        }
      },
      "isVisible": true,
      "isPositionLocked": false
    }

  ]
}

Schema

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

id: số
Định danh đối tượng
ví dụ: 1764

additional: Record<string, any>
Giá trị bổ sung từ chỉ mục
ví dụ:

{ 
  "prices": { 
    "min": 0, 
    "max": 100 
  } 
}

statusLocalizeInfos: CommonLocalizeInfos
Mô tả json về trạng thái của đối tượng, tính đến ngôn ngữ
ví dụ:

{ "title": "Sản phẩm" }

localizeInfos: Record<string, any>
Mô tả json về dữ liệu trang chính, tính đến ngôn ngữ "en_US" (ví dụ)
ví dụ:

{
  "en_US": {
    "title": "Danh mục",
    "plainContent": "Nội dung cho danh mục",
    "htmlContent": "<b>Nội dung cho danh mục</b>",
    "menuTitle": "Danh mục"
  }
}

isVisible: boolean
Cờ hiển thị trang
ví dụ: true

position: số
Số thứ tự (để sắp xếp)
ví dụ: 192

templateIdentifier: chuỗi
Định danh tùy chỉnh của mẫu liên kết
ví dụ: my-template

attributeSetId: số
Định danh bộ thuộc tính
ví dụ: 7

blocks: mảng
Các khối sản phẩm
ví dụ: ['product_block']

isSync: boolean
Chỉ báo về việc lập chỉ mục trang (true hoặc false)
ví dụ: false

attributeValues: Record<string, string>
Mảng các giá trị thuộc tính từ chỉ mục (được trình bày dưới dạng cặp định danh thuộc tính tùy chỉnh: giá trị thuộc tính)
ví dụ:

{
  "en_US": {
    "marker": {
      "value": "",
      "type": "string"
    }
  }
}

statusId: số
Định danh trạng thái của trang sản phẩm (có thể là null)
ví dụ: 1

sku: chuỗi
Giá trị SKU của sản phẩm lấy từ chỉ mục
ví dụ: 1

relatedIds: mảng
Định danh của các trang sản phẩm liên quan
ví dụ:

[ 1, 2, 3 ]

price: số
Giá trị giá của trang sản phẩm lấy từ chỉ mục
ví dụ: 0

templateIdentifier chuỗi
Định danh tùy chỉnh của mẫu liên kết
ví dụ: my-template

shortDescTemplateIdentifier chuỗi
Định danh tùy chỉnh của mẫu liên kết cho mô tả ngắn
ví dụ: my-template-short