Get Predictions and Element Details

Published on Nov 21, 2024

2 minute(s) read

Prev Next

Post

/render/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

context

object (Context)

the context object used for dynamic data

exclude

string

Context used to exclude specific items by id

Example123|456|789

pathname

string

The pathname of the page

Example/en-us/men/shirts

queryString

string

The query string of the page

Example?color=red&size=large&xse_page=home

recentlyViewed

string

The recently viewed items

Example123|456|789

xt_gender

string

Example how to pass dynamic context - The dynamic gender context

Examplefemale

Responses

200

Successful response

Expand All

object

render_data

Array of object

The render data object - includes the recommendations and the element details

object

element

object

The element details

element_name

string

The element's name

ExamplePDP Element

element_hook

string

The element's hook - the element used to render the recommendations

Example#element-hook

element_body

string

The element's html

Example<div>Element Body</div>

element_script

string

The element's JavaScript'

Exampleconsole.log('Element Script');

element_style

string

The element's CSS

Example.element-style { color: red; }

element_id

string

The element's id

Examplesm_el_1234

element_preview

string

Can the element be previewed

ExampleTrue

enabled

string

Whether the element is enabled. If "true" the element is published and can be used live.

ExampleTrue

localization

object

The localization settings for the element - this is where you can set language specific content

Example{ "view-all": { "en-us": "View All", "es-es": "Ver Todo" } }

property*

object additionalProperties

property*

string additionalProperties

max_recommendations

integer

The maximum number of recommendations to return

Example5

min_recommendations

integer

The minimum number of recommendations to return

Example1

no_recommendations

boolean

Whether to return no recommendations

ExampleFalse

preview_links

Array of string

The preview links used to preview the element

Example[ "https://www.example.com/preview-link-1?xse_preview=sm_el_1234", "https://www.example.com/preview-link-2?xse_preview=sm_el_1234" ]

string

ruleset_inactive

object

An inactive ruleset

exception

string

exclude

string

trigger

string

seml_version

string

The SEML version used to render the element

Example2.0

template_type

boolean

The template type used to render the element

ExampleFalse

tts_settings

object

The TTS settings used for a search element. This only applies to search elements.

ps_enabled

boolean

Primary search enabled

ps_trigger

string

Trigger type for primary search

ps_value

integer

The value of the trigger for primary search

tts_enabled

boolean

Whether TTS is enabled

tts_trigger

string

Trigger type for TTS

tts_value

The value of the trigger for TTS

OneOf

integer

string

boolean

prediction

Array of object (Product)

The predictions array

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

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal server error