getOrdersByVectorSearch

Pencarian semantik (vektor) untuk pesanan pengguna saat ini. 🔐 Metode ini memerlukan otorisasi.

Deskripsi

Metode ini melakukan pencarian semantik (vektor) atas pesanan pengguna yang terotorisasi dari kueri bahasa alami - mencocokkan berdasarkan makna daripada kata kunci yang tepat. Ini mengembalikan sebuah Promise yang menyelesaikan menjadi objek IOrdersByMarkerEntity - sebuah wadah dengan items (pesanan) dan total.

Orders.getOrdersByVectorSearch(

body*, langCode, offset, limit

);

Skema parameter

Skema

body(required): IOrdersVectorSearch
Isi pencarian vektor
contoh:

{ queryText: "winter jacket" }

body.queryText(required): string
Kueri pencarian dalam bahasa alami.
contoh: "jaket musim dingin"

body.vectorDistanceThreshold: number
Override ambang jarak kosinus (0..2).
contoh: 0.3

body.maxHits: number
Top-K kandidat yang diambil sebelum paginasi. Default: 100. Max: 500.
contoh: 10

body.debug: boolean
Ketika true, setiap item yang dikembalikan mendapatkan field distance.
contoh: false

langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"

offset: number
Parameter untuk paginasi. Default: 0
contoh: 0

limit: number
Parameter untuk paginasi. Default: 30
contoh: 30

Contoh

Contoh minimal

const response = await Orders.getOrdersByVectorSearch({ queryText: 'winter jacket' });

Contoh dengan atribut

const response = await Orders.getOrdersByVectorSearch(
  {
    queryText: 'winter jacket',
    vectorDistanceThreshold: 0.3,
    maxHits: 50,
    debug: true,
  },
  'en_US',
  0,
  30,
);

Contoh respons

{
  "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
}

Skema respons

Skema: IOrdersByMarkerEntity

items: IOrderByMarkerEntity[]
Array objek penyimpanan pesanan.
contoh:

[
  {
    "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
Identifikasi objek.
contoh: 125

items.storageId: number
Identifikasi objek penyimpanan pesanan.
contoh: 1

items.createdDate: string
Tanggal ketika pesanan dibuat.
contoh: "2023-10-01T12:00:00Z"

items.statusIdentifier: string
Identifikasi teks dari status pesanan.
contoh: "order-status-1"

items.formIdentifier: string
Identifikasi teks dari formulir.
contoh: "bar-orders-form"

items.formData: IOrdersFormData[]
Data yang dikirimkan oleh formulir yang terhubung ke penyimpanan pesanan.
contoh:

[
  {
    "marker": "order_name",
    "value": "Ivan",
    "type": "string"
  }
]

items.attributeSetIdentifier: string | null
Identifikasi teks dari set atribut.
contoh: "attribute-set-1"

items.totalSum: string
Jumlah total pesanan.
contoh: "100.00"

items.totalSumRaw: string
Jumlah total pesanan mentah dengan presisi penuh.
contoh: "100.00"

items.currency: string
Mata uang yang digunakan untuk membayar pesanan.
contoh: "USD"

items.paymentAccountIdentifier: string | null
Identifikasi teks untuk pembayaran pesanan.
contoh: "payment-1"

items.paymentAccountLocalizeInfos: ILocalizeInfo
Nama akun pembayaran dengan mempertimbangkan lokalisasi.
contoh:

{
  "title": "Cash"
}

items.products: IOrderProducts[]
Array produk yang ditambahkan ke pesanan.
contoh:

[
  {
    "id": 1,
    "name": "Product 1",
    "quantity": 2
  }
]

items.paymentUrl: string | null
Tautan pembayaran.
contoh: "https://example.com/pay/123"

items.isCompleted: boolean | null
Menunjukkan bahwa pesanan telah diselesaikan.
contoh: true

items.isPartial: boolean | null
Menunjukkan bahwa pesanan dibayar sebagian; null pada pesanan lama di mana ini tidak dilacak.
contoh: false

items.paymentStrategy: string
Strategi pembayaran dari pesanan.
contoh: "once"

items.statusLocalizeInfos: ILocalizeInfo
Nama status yang dilokalisasi.

items.fulfillmentStatusIdentifier: string | null
Identifikasi teks dari status pemenuhan (pengiriman); null saat tidak ada status pemenuhan yang ditetapkan.
contoh: "shipped"

items.fulfillmentStatusLocalizeInfos: ILocalizeInfo | null
Nama status pemenuhan yang dilokalisasi; null saat tidak ada status pemenuhan yang ditetapkan.

items.paymentStatusIdentifier: string | null
Identifikasi teks dari status pembayaran; null saat tidak ada status pembayaran yang ditetapkan.
contoh: "inProgress-payment"

items.paymentStatusLocalizeInfos: ILocalizeInfo | null
Nama status pembayaran yang dilokalisasi; null saat tidak ada status pembayaran yang ditetapkan.

items.discountConfig: IOrderDiscountConfig | null
Konfigurasi diskon yang diterapkan pada pesanan (orderDiscounts, productDiscounts, coupon, settings, bonus, totals); null pada pesanan lama tanpa konfigurasi diskon yang diselesaikan.

items.split: IOrderSplit
Konfigurasi pembayaran terpisah (staged); hadir pada endpoint pesanan berdasarkan ID.

items.distance: number
Jarak kosinus ke kueri. Hanya dikembalikan oleh endpoint pencarian semantik (vektor) ketika debug: true diteruskan dalam isi pencarian.
contoh: 0.12

total: number
Jumlah total catatan yang ditemukan.
contoh: 100

ℹ️ Pencarian semantik mencocokkan pada makna, bukan pada teks literal. Untuk pencocokan kata kunci di seluruh jenis entitas sekaligus gunakan globalSearch().

---