getOrdersByVectorSearch

Búsqueda semántica (vectorial) de los pedidos del usuario actual. 🔐 Este método requiere .

Descripción

Este método realiza una búsqueda semántica (vectorial) sobre los pedidos del usuario autorizado a partir de una consulta en lenguaje natural; se basa en el significado en lugar de en palabras clave exactas. Devuelve una Promesa que se resuelve en un objeto IOrdersByMarkerEntity: un contenedor con items (los pedidos) y total.

.getOrdersByVectorSearch(

, , ,

);

Esquema de parámetros

Esquema

body(required): IOrdersVectorSearch
Cuerpo de búsqueda vectorial
ejemplo:

{ queryText: "winter jacket" }

body.queryText(required): string
Consulta de búsqueda en lenguaje natural.
ejemplo: "chaqueta de invierno"

body.vectorDistanceThreshold: number
Anulación del umbral de distancia coseno (0..2).
ejemplo: 0.3

body.maxHits: number
Candidatos Top-K obtenidos antes de la paginación. Predeterminado: 100. Máx: 500.
ejemplo: 10

body.debug: boolean
Cuando es verdadero, cada elemento devuelto obtiene un campo distance.
ejemplo: false

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

offset: number
Parámetro para la paginación. Predeterminado: 0
ejemplo: 0

limit: number
Parámetro para la paginación. Predeterminado: 30
ejemplo: 30

Ejemplos

Ejemplo mínimo

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

Ejemplo con atributos

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

Ejemplo de respuesta

{
  "items": [],
  "total": 0
}

Esquema de respuesta

Esquema: IOrdersByMarkerEntity

items: IOrderByMarkerEntity[]
Array de objetos de almacenamiento de pedidos.
ejemplo:

[
  {
    "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
Identificador del objeto.
ejemplo: 125

items.storageId: number
Identificador del objeto de almacenamiento del pedido.
ejemplo: 1

items.createdDate: string
Fecha en que se creó el pedido.
ejemplo: "2023-10-01T12:00:00Z"

items.statusIdentifier: string
Identificador de texto del estado del pedido.
ejemplo: "order-status-1"

items.formIdentifier: string
Identificador de texto del formulario.
ejemplo: "bar-orders-form"

items.formData: IOrdersFormData[]
Datos enviados por el formulario vinculado al almacenamiento del pedido.
ejemplo:

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

items.attributeSetIdentifier: string | null
Identificador de texto del conjunto de atributos.
ejemplo: "attribute-set-1"

items.totalSum: string
Monto total del pedido.
ejemplo: "100.00"

items.totalSumRaw: string
Monto total bruto del pedido con plena precisión.
ejemplo: "100.00"

items.currency: string
Moneda utilizada para pagar el pedido.
ejemplo: "USD"

items.paymentAccountIdentifier: string | null
Identificador textual para el pago del pedido.
ejemplo: "payment-1"

items.paymentAccountLocalizeInfos: ILocalizeInfo
Nombre de la cuenta de pago considerando la localización.
ejemplo:

{
  "title": "Cash"
}

items.products: IOrderProducts[]
Array de productos añadidos al pedido.
ejemplo:

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

items.paymentUrl: string | null
Enlace de pago.
ejemplo: "https://example.com/pay/123"

items.isCompleted: boolean | null
Indica que el pedido ha sido completado.
ejemplo: true

items.isPartial: boolean | null
Indica que el pedido está parcialmente pagado; null en pedidos antiguos donde no se rastreó.
ejemplo: false

items.paymentStrategy: string
Estrategia de pago del pedido.
ejemplo: "once"

items.statusLocalizeInfos: ILocalizeInfo
Nombre del estado localizado.

items.fulfillmentStatusIdentifier: string | null
Identificador de texto del estado de cumplimiento (entrega); null mientras no se asigne un estado de cumplimiento.
ejemplo: "shipped"

items.fulfillmentStatusLocalizeInfos: ILocalizeInfo | null
Nombre del estado de cumplimiento localizado; null mientras no se asigne un estado de cumplimiento.

items.paymentStatusIdentifier: string | null
Identificador de texto del estado de pago; null mientras no se asigne un estado de pago.
ejemplo: "inProgress-payment"

items.paymentStatusLocalizeInfos: ILocalizeInfo | null
Nombre del estado de pago localizado; null mientras no se asigne un estado de pago.

items.discountConfig: IOrderDiscountConfig | null
Configuración de descuento resuelta aplicada al pedido (orderDiscounts, productDiscounts, coupon, settings, bonus, totals); null en pedidos antiguos sin una configuración de descuento resuelta.

items.split: IOrderSplit
Configuración de pago dividido (por etapas); presente en el endpoint de pedido por ID.

items.distance: number
Distancia coseno a la consulta. Devuelto solo por el endpoint de búsqueda semántica (vectorial) cuando se pasa debug: true en el cuerpo de búsqueda.
ejemplo: 0.12

total: number
Número total de registros encontrados.
ejemplo: 100

ℹ️ La búsqueda semántica se basa en el significado, no en el texto literal. Para coincidencias de palabras clave en todos los tipos de entidades a la vez, utiliza globalSearch().

---