getOrdersByVectorSearch
Tìm kiếm ngữ nghĩa (vector) cho các đơn hàng của người dùng hiện tại. 🔐 Phương thức này yêu cầu ủy quyền.
Mô tả
Phương thức này thực hiện tìm kiếm ngữ nghĩa (vector) trên các đơn hàng của người dùng đã được ủy quyền từ một truy vấn bằng ngôn ngữ tự nhiên - nó khớp với ý nghĩa thay vì từ khóa chính xác. Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng IOrdersByMarkerEntity - một container với items (các đơn hàng) và total.
Orders.getOrdersByVectorSearch(
body*,
langCode,
offset,
limit
);
Sơ đồ tham số
Sơ đồ
body(bắt buộc): IOrdersVectorSearch
Nội dung tìm kiếm vector
ví dụ:
{ queryText: "winter jacket" }
body.queryText(bắt buộc): string
Truy vấn tìm kiếm bằng ngôn ngữ tự nhiên.
ví dụ: "áo khoác mùa đông"
body.vectorDistanceThreshold: number
Ghi đè ngưỡng khoảng cách cosine (0..2).
ví dụ: 0.3
body.maxHits: number
Các ứng viên hàng đầu được lấy trước khi phân trang. Mặc định: 100. Tối đa: 500.
ví dụ: 10
body.debug: boolean
Khi true, mỗi mục trả về sẽ có trường distance.
ví dụ: false
langCode: string
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"
offset: number
Tham số cho phân trang. Mặc định: 0
ví dụ: 0
limit: number
Tham số cho phân trang. Mặc định: 30
ví dụ: 30
Ví dụ
Ví dụ tối thiểu
const response = await Orders.getOrdersByVectorSearch({ queryText: 'winter jacket' });
Ví dụ với thuộc tính
const response = await Orders.getOrdersByVectorSearch(
{
queryText: 'winter jacket',
vectorDistanceThreshold: 0.3,
maxHits: 50,
debug: true,
},
'en_US',
0,
30,
);
Ví dụ phản hồi
{
"items": [
{
"id": 746,
"storageId": 1,
"createdDate": "2026-08-14T13:02:50.761Z",
"statusIdentifier": "inProgress-payment",
"statusLocalizeInfos": {
"title": "In progress"
},
"fulfillmentStatusIdentifier": null,
"fulfillmentStatusLocalizeInfos": null,
"paymentStatusIdentifier": "inProgress-payment",
"paymentStatusLocalizeInfos": {
"title": "In progress"
},
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"paymentStrategy": "once",
"totalSum": "285",
"totalSumRaw": "300",
"currency": "USD",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Cash"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": [],
"price": 150,
"quantity": 2,
"isGift": false
}
],
"paymentUrl": null,
"discountConfig": {
"orderDiscounts": [
{
"id": 2,
"identifier": "personal_discount",
"type": "PERSONAL_DISCOUNT",
"localizeInfos": {
"title": "Personal discount"
},
"startDate": "2026-04-21T18:26:19.815Z",
"endDate": "2028-03-21T19:26:24.741Z",
"discountValue": {
"value": 15,
"maxAmount": null,
"discountType": "FIXED_AMOUNT",
"applicability": "TO_ORDER"
},
"exclusions": null,
"position": 1,
"conditionLogic": "AND",
"gifts": [],
"userGroups": null,
"userExclusions": null,
"conditions": [],
"coupon": null
}
],
"productDiscounts": [],
"coupon": null,
"settings": {
"allowStacking": true,
"maxDiscountValue": 50,
"allowGiftStacking": false,
"maxBonusPaymentPercent": null,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"giftRefundPolicy": "KEEP_GIFT"
},
"additionalDiscountsMarkers": [],
"totalRaw": 300,
"totalSumWithDiscount": 285,
"excludedGiftProductIds": [],
"bonus": {
"availableBalance": 0,
"maxBonusDiscount": 0,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"bonusApplied": 0
},
"bonusApplied": 0,
"totalDue": 285
},
"isPartial": false,
"isCompleted": null
}
],
"total": 1
}
Sơ đồ phản hồi
Sơ đồ: IOrdersByMarkerEntity
items: IOrderByMarkerEntity[]
Mảng các đối tượng lưu trữ đơn hàng.
ví dụ:
[
{
"id": 55,
"storageId": 1,
"createdDate": "2025-03-22T21:12:42.371Z",
"statusIdentifier": "inProgress",
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"totalSum": "300.00",
"currency": "",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Cash"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": null,
"price": 150,
"quantity": 2
}
],
"isCompleted": false
}
]
items.id: number
Định danh đối tượng.
ví dụ: 125
items.storageId: number
Định danh của đối tượng lưu trữ đơn hàng.
ví dụ: 1
items.createdDate: string
Ngày khi đơn hàng được tạo.
ví dụ: "2023-10-01T12:00:00Z"
items.statusIdentifier: string
Định danh văn bản của trạng thái đơn hàng.
ví dụ: "order-status-1"
items.formIdentifier: string
Định danh văn bản của biểu mẫu.
ví dụ: "bar-orders-form"
items.formData: IOrdersFormData[]
Dữ liệu được gửi bởi biểu mẫu liên kết với cửa hàng đơn hàng.
ví dụ:
[
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
]
items.attributeSetIdentifier: string | null
Định danh văn bản của bộ thuộc tính.
ví dụ: "attribute-set-1"
items.totalSum: string
Tổng số tiền đơn hàng.
ví dụ: "100.00"
items.totalSumRaw: string
Tổng số tiền đơn hàng thô với độ chính xác đầy đủ.
ví dụ: "100.00"
items.currency: string
Tiền tệ được sử dụng để thanh toán cho đơn hàng.
ví dụ: "USD"
items.paymentAccountIdentifier: string | null
Định danh văn bản cho thanh toán đơn hàng.
ví dụ: "payment-1"
items.paymentAccountLocalizeInfos: ILocalizeInfo
Tên tài khoản thanh toán với sự xem xét địa phương hóa.
ví dụ:
{
"title": "Cash"
}
items.products: IOrderProducts[]
Mảng các sản phẩm được thêm vào đơn hàng.
ví dụ:
[
{
"id": 1,
"name": "Product 1",
"quantity": 2
}
]
items.paymentUrl: string | null
Liên kết thanh toán.
ví dụ: "https://example.com/pay/123"
items.isCompleted: boolean | null
Chỉ ra rằng đơn hàng đã được hoàn thành.
ví dụ: true
items.isPartial: boolean | null
Chỉ ra rằng đơn hàng đã được thanh toán một phần; null trên các đơn hàng cũ mà không được theo dõi.
ví dụ: false
items.paymentStrategy: string
Chiến lược thanh toán của đơn hàng.
ví dụ: "once"
items.statusLocalizeInfos: ILocalizeInfo
Tên trạng thái đã được địa phương hóa.
items.fulfillmentStatusIdentifier: string | null
Định danh văn bản của trạng thái hoàn thành (giao hàng); null khi không có trạng thái hoàn thành nào được chỉ định.
ví dụ: "shipped"
items.fulfillmentStatusLocalizeInfos: ILocalizeInfo | null
Tên trạng thái hoàn thành đã được địa phương hóa; null khi không có trạng thái hoàn thành nào được chỉ định.
items.paymentStatusIdentifier: string | null
Định danh văn bản của trạng thái thanh toán; null khi không có trạng thái thanh toán nào được chỉ định.
ví dụ: "inProgress-payment"
items.paymentStatusLocalizeInfos: ILocalizeInfo | null
Tên trạng thái thanh toán đã được địa phương hóa; null khi không có trạng thái thanh toán nào được chỉ định.
items.discountConfig: IOrderDiscountConfig | null
Cấu hình giảm giá đã được giải quyết áp dụng cho đơn hàng (orderDiscounts, productDiscounts, coupon, settings, bonus, totals); null trên các đơn hàng cũ mà không có cấu hình giảm giá đã được giải quyết.
items.split: IOrderSplit
Cấu hình thanh toán chia (giai đoạn); có mặt trên điểm cuối đơn hàng theo ID.
items.distance: number
Khoảng cách cosine đến truy vấn. Chỉ được trả về bởi điểm cuối tìm kiếm ngữ nghĩa (vector) khi debug: true được truyền vào trong nội dung tìm kiếm.
ví dụ: 0.12
total: number
Tổng số bản ghi đã tìm thấy.
ví dụ: 100
ℹ️ Tìm kiếm ngữ nghĩa khớp với ý nghĩa, không phải với văn bản cụ thể. Để khớp từ khóa trên mọi loại thực thể cùng một lúc, hãy sử dụng globalSearch().