Get search results

Published on Nov 21, 2024

Post

/customers/{customerId}/users/{userId}

Security

API Key

Header parameter nameaccess_token

Access token Authentication

Path parameters

customerId

stringRequired

userId

stringRequired

Body parameters

Expand All

object

Example{ "deployment_id": "1234", "query": "sneakers", "collection": "us", "page": 1, "context": { "gender": "female" }, "field_sort": "price", "field_sort_order": "asc" }

deployment_id

string

The deplyment id (which holds the attached behavior settings) to use for the search

behavior_id

string

The bahavior id to use for the search

query

string Required

The search query term

context

object

The context object used for dynamic filtering/faceting

perform_faceting

boolean

Whether to perform and return faceting results

page

integer

The page number of results to return

use_opensearch_neural_as_primary

boolean

Setting this to true will force DeepSearch results.

collection

string Required

The collection to search in

field_sort

string

The field to sort results by

Valid values[ "price", "update_date" ]

field_sort_order

string

The order to sort results by

Valid values[ "asc", "desc" ]

Responses

200

Successful response

Expand All

object

page

integer

The page number of the results

total_result

integer

The total number of results available

text_completion

string

When using Chat, the gateway returns the text completion which allows for a conversational mode

error

string

When an error occurs, the gateway returns the error message

behavior_id

string

The behavior id used for the search

keyword

string

The keyword matched (if any)

message

string

Gives details about keyword matches

url_redirect

string

The redirect URL (if any)

response_engine

string

The response engine used

sorted_by

string

The product filter used to sort the results

is_from_cache

boolean

Whether this response was retrieved from cache

is_keyword_config_applied

boolean

Whether the keyword configuration was applied

is_filter_applied

boolean

Whether a filter was applied

is_cached_filter_applied

boolean

Whether a cached filter was applied

is_url_redirect

boolean

Whether this matched a URL redirect keyword

products_list

Array of object (Product)

List of products

object

brand

string

ExampleYour brand

color

string

ExampleOrange

currency

string

ExampleUSD

currency_symbol

string

Example$

custom_string_1

string

Examplesome string 1

custom_string_2

string

Examplesome string 2

custom_string_3

string

Examplesome string 3

custom_string_4

string

Examplesome string 4

custom_string_5

string

Examplesome string 5

gender

string

Examplefemale

image

string (uri)

Examplehttps://www.example.com/image.jpg

image_alt

string (uri)

Examplehttps://www.example.com/image-alt.jpg

is_in_stock

string

Example1

is_on_sale

string

Example0

item_type

string

Exampleadult

macroCategory

string

ExampleDresses

macroColor

string

ExampleOrange

microCategory

string

ExampleLong Dresses

price

number (float)

Example11500

prod_code

string

Exampleabc123

prod_name

string

ExampleYour Prod Name

product_types

Array of string

Example[ "Woman", "Dresses", "Long Dresses" ]

string

product_url

string (uri)

Examplehttps://link-to-product.com

sale_price

number (float)

Example11000

size

string

Example2

product_code_variant_mapping

object

Mapping of product codes to variants

search_term_matches

Array of string

List of search term matches

string

user_data

object (User)

The user object

access_token

string

refresh_token

string

expiration_date

string

session_id

string

user_id

string

The user id

user_type

string

The user type

facet

object

Facet results

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal server error