getProducts

Tìm kiếm tất cả các đối tượng sản phẩm với phân trang và bộ lọc

Products.getProducts(body, langCode, userQuery)

const body = [
  {
    "attributeMarker": "price",
    "conditionMarker": "mth",
    "statusMarker": "waiting",
    "conditionValue": 1,
    "pageUrls": [
      "23-laminat-floorwood-maxima"
    ],
    "isNested": false,
    "title": ""
  },
  {
    "attributeMarker": "price",
    "conditionMarker": "lth",
    "conditionValue": 3,
    "pageUrls": [
      "23-laminat-floorwood-maxima"
    ],
    "isNested": false,
    "title": ""
  }
]

const value = await Products.getProducts(body)

Schema

body:* IFilterParams[]
Nội dung yêu cầu. Mặc định là [].
ví dụ: []

langCode: string
Tham số 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.

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

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

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

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

userQuery.statusId: number
Tham số tùy chọn - tìm kiếm theo id trạng thái
ví dụ: 1

userQuery.statusMarker: string
Định danh tùy chọn của trạng thái trang sản phẩm
ví dụ: waiting

userQuery.conditionValue: string
Giá trị tùy chọn đang được tìm kiếm
ví dụ: 3

userQuery.conditionMarker: string
Định danh tùy chọn của điều kiện bộ lọc mà theo đó các giá trị được lọc
ví dụ: mth

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

Schema (body)

attributeMarker: string
định danh văn bản của thuộc tính
ví dụ: price

conditionMarker: string
định danh văn bản của điều kiện
ví dụ: in

statusMarker: string
định danh văn bản của trạng thái trang sản phẩm (mặc định không được thiết lập)
ví dụ: status_1

conditionValue: number
giá trị điều kiện
ví dụ: 1

pageUrls: Array<string>
phần duy nhất của URL trang (sau dấu "/" cuối cùng)

title: string
ví dụ: Iphone 17 Pro
tên sản phẩm

isNested: boolean
chỉ báo tìm kiếm cho tất cả các danh mục lồng nhau (pageUrls)
ví dụ: false

Phương thức này 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, dựa trên các tham số truy vấn đã cung cấp (userQuery). Nó trả về một Promise mà khi giải quyết sẽ trả về một mảng các mục, trong đó mỗi mục là một đối tượng.

Ví dụ trả về:

{
  "total": 100,
  "items": [
    {
      "id": 4,
      "localizeInfos": {
        "title": "Cosmo"
      },
      "statusIdentifier": null,
      "statusLocalizeInfos": {},
      "attributeSetIdentifier": "products",
      "position": 1,
      "templateIdentifier": null,
      "isPositionLocked": false,
      "shortDescTemplateIdentifier": null,
      "price": 150,
      "additional": {
        "prices": {
          "min": 120,
          "max": 150
        }
      },
      "sku": null,
      "isSync": true,
      "attributeValues": {
        "price": {
          "type": "integer",
          "value": 150,
          "position": 1,
          "isProductPreview": false
        },
        "product-name": {
          "type": "string",
          "value": "Cosmo",
          "position": 0,
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "",
          "position": 2,
          "isProductPreview": false
        }
      },
      "isVisible": true
    }
  ]
}

Schema

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

id: number
đị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 của đối tượng trạng thái, tính đến ngôn ngữ
ví dụ:

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

localizeInfos: Record<string, any>
mô tả json của đối tượng 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: number
số thứ tự (để sắp xếp)
ví dụ: 192

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

attributeSetId: number
định danh bộ thuộc tính
ví dụ: 7

blocks: array
các khối sản phẩm
ví dụ:

["product_block"]

isSync: boolean
chỉ báo 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: number
định danh trạng thái của trang sản phẩm (có thể là null)
ví dụ: 1

sku: string
giá trị SKU sản phẩm lấy từ chỉ mục
ví dụ: 1

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

[ 1, 2, 3 ]

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

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

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