Skip to main content

SearchRequestDTO

querystringrequired

Possible values: >= 2 characters and <= 200 characters

shopIdstring
limitint32

Possible values: >= 1 and <= 50

offsetint32

Possible values: >= 0

sortBystring
intentIdstring
previousQuerystring
filters object
priceMinnumber
priceMaxnumber
categorystring
brandstring
inStockOnlyboolean
appliedFilters object
property name*any
guidedFilters object[]
  • Array [
  • idstring
    questionstring
    typestring
    priorityint32
    options object[]
  • Array [
  • labelstring
    filter object
    property name*any
    countint32
    isSelectedboolean
    isRecommendedboolean
  • ]
  • ]
  • inputMethodstring
    clearFiltersboolean
    langstring

    Possible values: Value must match regular expression ^[a-z]{2}$

    cartContext object
    currencystringrequired

    Possible values: <= 8 characters

    totalItemsint32

    Possible values: >= 0 and <= 200

    subtotalnumberrequired

    Possible values: >= 0

    totalnumberrequired

    Possible values: >= 0

    formattedSubtotalstring

    Possible values: <= 32 characters

    formattedTotalstring

    Possible values: <= 32 characters

    items object[]

    Possible values: <= 50

  • Array [
  • productIdstringrequired

    Possible values: <= 64 characters

    externalIdstring

    Possible values: <= 64 characters

    namestringrequired

    Possible values: <= 120 characters

    quantityint32

    Possible values: >= 1 and <= 99

    unitPricenumberrequired

    Possible values: >= 0

    lineTotalnumberrequired

    Possible values: >= 0

    formattedUnitPricestring

    Possible values: <= 32 characters

    formattedLineTotalstring

    Possible values: <= 32 characters

    variantstring

    Possible values: <= 80 characters

  • ]
  • truncatedboolean
    hashstring

    Possible values: <= 16 characters

    updatedAtdate-timerequired
    shipping object
    needsCountryResolutionboolean
    freeShippingThresholdnumber

    Possible values: >= 0

    currentAmountnumber

    Possible values: >= 0

    deltanumber

    Possible values: >= 0

    thresholdMetboolean
    destinationCountrystring

    Possible values: Value must match regular expression ^[A-Z]{2}$

    destinationLabelstring

    Possible values: <= 80 characters

    formattedThresholdstring

    Possible values: <= 32 characters

    formattedDeltastring

    Possible values: <= 32 characters

    availableCountries object[]

    Possible values: <= 50

  • Array [
  • codestring

    Possible values: Value must match regular expression ^[A-Z]{2}$

    labelstring

    Possible values: <= 80 characters

    thresholdnumber

    Possible values: >= 0

  • ]
  • SearchRequestDTO
    {
    "query": "string",
    "shopId": "string",
    "limit": 0,
    "offset": 0,
    "sortBy": "string",
    "intentId": "string",
    "previousQuery": "string",
    "filters": {
    "priceMin": 0,
    "priceMax": 0,
    "category": "string",
    "brand": "string",
    "inStockOnly": true
    },
    "appliedFilters": {},
    "guidedFilters": [
    {
    "id": "string",
    "question": "string",
    "type": "string",
    "priority": 0,
    "options": [
    {
    "label": "string",
    "filter": {},
    "count": 0,
    "isSelected": true,
    "isRecommended": true
    }
    ]
    }
    ],
    "inputMethod": "string",
    "clearFilters": true,
    "lang": "string",
    "cartContext": {
    "currency": "string",
    "totalItems": 0,
    "subtotal": 0,
    "total": 0,
    "formattedSubtotal": "string",
    "formattedTotal": "string",
    "items": [
    {
    "productId": "string",
    "externalId": "string",
    "name": "string",
    "quantity": 0,
    "unitPrice": 0,
    "lineTotal": 0,
    "formattedUnitPrice": "string",
    "formattedLineTotal": "string",
    "variant": "string"
    }
    ],
    "truncated": true,
    "hash": "string",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "shipping": {
    "needsCountryResolution": true,
    "freeShippingThreshold": 0,
    "currentAmount": 0,
    "delta": 0,
    "thresholdMet": true,
    "destinationCountry": "string",
    "destinationLabel": "string",
    "formattedThreshold": "string",
    "formattedDelta": "string",
    "availableCountries": [
    {
    "code": "string",
    "label": "string",
    "threshold": 0
    }
    ]
    }
    }
    }