getOrdersByVectorSearch

Busca semântica (vetorial) para os pedidos do usuário atual. 🔐 Este método requer autorização.

Descrição

Este método realiza uma busca semântica (vetorial) sobre os pedidos do usuário autorizado a partir de uma consulta em linguagem natural - ele corresponde ao significado em vez de palavras-chave exatas. Retorna uma Promise que resolve para um objeto IOrdersByMarkerEntity - um contêiner com items (os pedidos) e total.

Orders.getOrdersByVectorSearch(
body*,
langCode,
offset,
limit
);

Esquema de parâmetros

Esquema

body(obrigatório): IOrdersVectorSearch
Corpo da busca vetorial
exemplo:

{ queryText: "winter jacket" }

body.queryText(obrigatório): string
Consulta de busca em linguagem natural.
exemplo: "jaqueta de inverno"

body.vectorDistanceThreshold: number
Substituição do limite de distância do cosseno (0..2).
exemplo: 0.3

body.maxHits: number
Top-K candidatos buscados antes da paginação. Padrão: 100. Máx: 500.
exemplo: 10

body.debug: boolean
Quando verdadeiro, cada item retornado recebe um campo distance.
exemplo: false

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

offset: number
Parâmetro para paginação. Padrão: 0
exemplo: 0

limit: number
Parâmetro para paginação. Padrão: 30
exemplo: 30

Exemplos

Exemplo mínimo

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

Exemplo com atributos

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

Exemplo de resposta

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

Esquema de resposta

Esquema: IOrdersByMarkerEntity

items: IOrderByMarkerEntity[]
Array de objetos de armazenamento de pedidos.
exemplo:

[
  {
    "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 do objeto.
exemplo: 125

items.storageId: number
Identificador do objeto de armazenamento do pedido.
exemplo: 1

items.createdDate: string
Data em que o pedido foi criado.
exemplo: "2023-10-01T12:00:00Z"

items.statusIdentifier: string
Identificador textual do status do pedido.
exemplo: "order-status-1"

items.formIdentifier: string
Identificador textual do formulário.
exemplo: "bar-orders-form"

items.formData: IOrdersFormData[]
Dados enviados pelo formulário vinculado ao armazenamento do pedido.
exemplo:

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

items.attributeSetIdentifier: string | null
Identificador textual do conjunto de atributos.
exemplo: "attribute-set-1"

items.totalSum: string
Valor total do pedido.
exemplo: "100.00"

items.totalSumRaw: string
Valor total bruto do pedido com total precisão.
exemplo: "100.00"

items.currency: string
Moeda utilizada para pagar o pedido.
exemplo: "USD"

items.paymentAccountIdentifier: string | null
Identificador textual para o pagamento do pedido.
exemplo: "payment-1"

items.paymentAccountLocalizeInfos: ILocalizeInfo
Nome da conta de pagamento considerando a localização.
exemplo:

{
  "title": "Cash"
}

items.products: IOrderProducts[]
Array de produtos adicionados ao pedido.
exemplo:

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

items.paymentUrl: string | null
Link de pagamento.
exemplo: "https://example.com/pay/123"

items.isCompleted: boolean | null
Indica que o pedido foi concluído.
exemplo: true

items.isPartial: boolean | null
Indica que o pedido está parcialmente pago; null em pedidos mais antigos onde isso não foi rastreado.
exemplo: false

items.paymentStrategy: string
Estratégia de pagamento do pedido.
exemplo: "once"

items.statusLocalizeInfos: ILocalizeInfo
Nome do status localizado.

items.fulfillmentStatusIdentifier: string | null
Identificador textual do status de cumprimento (entrega); null enquanto nenhum status de cumprimento estiver atribuído.
exemplo: "shipped"

items.fulfillmentStatusLocalizeInfos: ILocalizeInfo | null
Nome do status de cumprimento localizado; null enquanto nenhum status de cumprimento estiver atribuído.

items.paymentStatusIdentifier: string | null
Identificador textual do status de pagamento; null enquanto nenhum status de pagamento estiver atribuído.
exemplo: "inProgress-payment"

items.paymentStatusLocalizeInfos: ILocalizeInfo | null
Nome do status de pagamento localizado; null enquanto nenhum status de pagamento estiver atribuído.

items.discountConfig: IOrderDiscountConfig | null
Configuração de desconto resolvida aplicada ao pedido (orderDiscounts, productDiscounts, coupon, settings, bonus, totals); null em pedidos mais antigos sem uma configuração de desconto resolvida.

items.split: IOrderSplit
Configuração de pagamento dividido (em etapas); presente no endpoint de pedido por ID.

items.distance: number
Distância cosseno em relação à consulta. Retornado apenas pelo endpoint de busca semântica (vetorial) quando debug: true é passado no corpo da busca.
exemplo: 0.12

total: number
Total de registros encontrados.
exemplo: 100

ℹ️ A busca semântica corresponde ao significado, não ao texto literal. Para correspondência de palavras-chave em todos os tipos de entidades de uma vez, use globalSearch().

Descrição​

Esquema de parâmetros​

Exemplos​

Exemplo mínimo​

Exemplo com atributos​

Exemplo de resposta​

Esquema de resposta​