Přeskočit na hlavní obsah
API docs by Redocly

UpSearch API (3)

Download OpenAPI specification:Download

UpSearch FrontApi

UpSearch is the third application in your project, primarily focused on e-commerce. It provides insights into all activities related to search usage and includes features for influencing search results.

Since UpSearch contains data such as your products, categories, brands, and articles, it can also serve as an endpoint for displaying catalogs, data in mobile applications, and more.

Admin

Admin API for platform management

Get dashboard KPIs

Returns platform KPIs including MRR, project counts, user counts, and search volume.

Responses

Get service health

Returns health status of all platform services.

Responses

List projects

Returns paginated list of all projects with optional filters.

query Parameters
page
integer
Default: 1
limit
integer <= 100
Default: 50
status
string
Enum: "active" "inactive" "all"
search
string

Responses

Get project detail

Returns detailed information about a specific project.

path Parameters
id
required
integer

Responses

Pause project

Pauses a project by setting activated to false. Paused projects do not return search results.

path Parameters
id
required
integer

Responses

Resume project

Resumes a paused project by setting activated to true.

path Parameters
id
required
integer

Responses

Reindex project

Dispatches feed import jobs for all active feeds of a project, triggering a full reindex.

path Parameters
id
required
integer
Request Body schema: application/json
optional
collection_id
integer

Optional: only reindex feeds for this collection

full
boolean

Force full reload

Responses

Request samples

Content type
application/json
{
  • "collection_id": 0,
  • "full": false
}

Impersonate project owner

Creates an impersonation token for logging into the merchant dashboard as the project owner.

path Parameters
id
required
integer

Responses

Infrastructure services detail

Returns detailed health and metrics for all platform services.

Responses

Infrastructure jobs overview

Returns background job summary, recent jobs, and queue depths.

query Parameters
status
string
Enum: "dispatched" "processing" "completed" "failed" "retrying"
type
string
limit
integer <= 200
Default: 50

Responses

Scheduled jobs overview

Returns list of scheduled jobs with their last run status and next run time.

Responses

List users

Returns paginated list of all platform users with project counts.

query Parameters
page
integer
Default: 1
limit
integer <= 100
Default: 50
search
string
status
string
Enum: "active" "inactive" "all"
sort
string
Default: "id"
Enum: "id" "name" "email" "joined" "projects_owned"
order
string
Default: "desc"
Enum: "asc" "desc"
trial
string
Enum: "true" "false"
super_admin
string
Enum: "true" "false"
date_from
string <date>

Registration date from (YYYY-MM-DD)

date_to
string <date>

Registration date to (YYYY-MM-DD)

has_projects
string
Enum: "true" "false"

Filter users who own at least one project

Responses

Analyze

Analyze search results and Elasticsearch queries

Compare results

Compares search results and scoring between two items.

Authorizations:
OAuthTokenSession

Responses

Analyze term

Analyzes a search term using various Elasticsearch analyzers.

Authorizations:
OAuthTokenSession

Responses

Audit Log

View audit trail for configuration changes

List audit logs

Returns paginated audit logs with optional filtering by entity type, action, user, and date range.

Authorizations:
Session
query Parameters
entity_type
string

Filter by entity type (synonym, fixit, relevance_tuning, etc.)

action
string
Enum: "create" "update" "delete" "bulk_create" "bulk_update" "bulk_delete" "import" "restore"

Filter by action (create, update, delete)

user_id
integer

Filter by user ID

from
string <date-time>

Filter from date (ISO 8601 format)

to
string <date-time>

Filter to date (ISO 8601 format)

search
string

Search in entity_name and diff_summary

page
integer
Default: 1

Page number (default: 1)

per_page
integer
Default: 50

Items per page (default: 50, max: 100)

Responses

Response Schema: application/json
err
integer
msg
string
data
Array of objects
object
object

Response samples

Content type
application/json
{
  • "err": 0,
  • "msg": "",
  • "data": [
    ],
  • "meta": {
    },
  • "filters": {
    }
}

Get audit log by ID

Returns detailed information about a specific audit log entry including full diff.

Authorizations:
Session
path Parameters
id
required
integer

Audit log ID

Responses

Response Schema: application/json
err
integer
msg
string
data
object

Response samples

Content type
application/json
{
  • "err": 0,
  • "msg": "",
  • "data": { }
}

Get entity change history

Returns chronological history of all changes made to a specific entity.

Authorizations:
Session
path Parameters
type
required
string

Entity type

entityId
required
string

Entity ID

Responses

Response Schema: application/json
err
integer
msg
string
data
Array of objects

Response samples

Content type
application/json
{
  • "err": 0,
  • "msg": "",
  • "data": [
    ]
}

Get activity summary

Returns aggregated statistics about audit log activity.

Authorizations:
Session
query Parameters
period
string
Default: "7d"

Time period (7d, 30d, 90d)

Responses

Response Schema: application/json
err
integer
msg
string
object

Response samples

Content type
application/json
{
  • "err": 0,
  • "msg": "",
  • "data": {
    }
}

Export audit logs to CSV

Export filtered audit logs as CSV file.

Authorizations:
Session
query Parameters
entity_type
string
action
string
from
string
to
string

Responses

Get users with audit activity

Returns list of users who have made changes (for filtering).

Authorizations:
Session

Responses

Response Schema: application/json
err
integer
msg
string
data
Array of objects

Response samples

Content type
application/json
{
  • "err": 0,
  • "msg": "",
  • "data": [
    ]
}

Authentication

OAuth 2.0 authentication and token management

Get client credentials

Returns the client credentials (client_id and client_secret) for the current sales channel.

Authorizations:
OAuthTokenSession

Responses

Refreshing Access Tokens: OAuth 2.0 Code Flow Mechanism

This request is part of the OAuth 2.0 authorization code flow. It allows clients to obtain a new access token by submitting a valid refresh token. The refresh token, which is issued during the initial authorization process, can be used to request a new access token without requiring the user to log in again.

Request Body schema: application/json
required

The request format to call refresh-token to get a refresh token differs between the code flow and PKCE flow.

One of
client_id
required
string

The Upsearch-issued ID of your application, which is available on the Credentials page in the Upsearch Dashboard. Max Length 200

client_secret
required
string

The Upsearch-issued application secret for your application, which is available on Credentials page in the Upsearch Dashboard. Max Length 1024.

Responses

Response Schema: application/json
access_token
required
string

A valid OAuth access token. Provide the access token in a header with every request to Connect API endpoints.

refresh_token
required
string

A refresh token. For more information, see Refresh, and Revoke token.

token_type
required
string

This value is always bearer.

expires_at
required
string
refresh_token_expires_at
string

The date when the refresh_token expires, in ISO 8601 format.

project_id
required
integer

The ID of the authorizing project.

Request samples

Content type
application/json
Example
{
  • "client_id": "525ce0cee17d25297b9baaef0bd21b90",
  • "client_secret": "da09ec117af274e11518c979cfae10dd711b4645810c87ba2a2fc0d59c3053a7"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MTI4NjQyMTEsImp0aSI6InZPb1R4NnJQTzdaLzY0bEQwWkZieFE9PSIsImlzcyI6ImFjY2Vzc190b2tlbiIsIm5iZiI6MTcxMjg2NDIxMSwiZXhwIjoxNzEyODY2MDExLCJkYXRhIjp7ImNsaWVud",
  • "refresh_token": "BkY2RkZmE4NGFkNTUyY2FhNmQzMThkOGZkYmJiZCJ9fQ.phBbLvFB3Rkh_Gj1LCNLDovYdix5YhGfmBsm8vqOsyE.phBbLvFB3Rkh_Gj1LCNLDovYdix5YhGfmBsm8vqOsyE",
  • "token_type": "bearer",
  • "expires_at": "2024-06-03T22:19:44Z",
  • "refresh_token_expires_at": "2024-08-03T22:19:44Z",
  • "project_id": 200
}

OAuth Token Generation: Issuing Access and Refresh Tokens

This endpoint generates and returns an OAuth access token and a refresh token. The access token is used to authenticate subsequent requests and is valid for 30 days, after which it expires. To avoid interrupting the user session, a refresh token is also provided. The refresh token allows the client to request a new access token without requiring re-authentication.

Request Body schema: application/json
required

Tokens for verification can be found in the admin under the credentials option.

client_id
required
string

The Upsearch-issued ID of your application, which is available on the Credentials page in the Upsearch Dashboard. Max Length 200

client_secret
required
string

The Upsearch-issued application secret for your application, which is available on Credentials page in the Upsearch Dashboard. Max Length 1024.

Responses

Response Schema: application/json
access_token
required
string

A valid OAuth access token. Provide the access token in a header with every request to Connect API endpoints.

refresh_token
required
string

A refresh token. For more information, see Refresh, and Revoke token.

token_type
required
string

This value is always bearer.

expires_at
required
string
refresh_token_expires_at
string

The date when the refresh_token expires, in ISO 8601 format.

project_id
required
integer

The ID of the authorizing project.

Request samples

Content type
application/json
{
  • "client_id": "525ce0cee17d25297b9baaef0bd21b90",
  • "client_secret": "da09ec117af274e11518c979cfae10dd711b4645810c87ba2a2fc0d59c3053a7"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MTI4NjQyMTEsImp0aSI6InZPb1R4NnJQTzdaLzY0bEQwWkZieFE9PSIsImlzcyI6ImFjY2Vzc190b2tlbiIsIm5iZiI6MTcxMjg2NDIxMSwiZXhwIjoxNzEyODY2MDExLCJkYXRhIjp7ImNsaWVud",
  • "refresh_token": "BkY2RkZmE4NGFkNTUyY2FhNmQzMThkOGZkYmJiZCJ9fQ.phBbLvFB3Rkh_Gj1LCNLDovYdix5YhGfmBsm8vqOsyE.phBbLvFB3Rkh_Gj1LCNLDovYdix5YhGfmBsm8vqOsyE",
  • "token_type": "bearer",
  • "expires_at": "2024-06-03T22:19:44Z",
  • "refresh_token_expires_at": "2024-08-03T22:19:44Z",
  • "project_id": 200
}

CharFilter

Manage character filters for search normalization

List all character filters

Returns all character filters configured for the current sales channel.

Authorizations:
OAuthTokenSession

Responses

Response Schema: application/json
err
integer
msg
string
Array of objects

Response samples

Content type
application/json
{
  • "err": 0,
  • "msg": "",
  • "data": [
    ]
}

Create a character filter

Adds a new character to be filtered during search. Common filters include punctuation marks and special characters.

Authorizations:
OAuthTokenSession
Request Body schema: application/json
required
term
required
string

The character to filter

Responses

Response Schema: application/json
err
integer
msg
string
object

Request samples

Content type
application/json
{
  • "term": "&"
}

Response samples

Content type
application/json
{
  • "err": 0,
  • "msg": "",
  • "data": {
    }
}

Delete character filter

Removes a character filter by its ID.

Authorizations:
OAuthTokenSession
path Parameters
id
required
integer

Character filter ID

Responses

Response Schema: application/json
err
integer
msg
string
data
null

Response samples

Content type
application/json
{
  • "err": 0,
  • "msg": "",
  • "data": null
}

Reset to default character filters

Removes all existing character filters and adds a predefined set of common special characters and punctuation marks.

Authorizations:
OAuthTokenSession

Responses

Response Schema: application/json
err
integer
msg
string
data
Array of objects

Response samples

Content type
application/json
{
  • "err": 0,
  • "msg": "",
  • "data": [
    ]
}

CheckItems

Manage check items for search validation

List check items

Retrieves all check items and validates their positions.

Authorizations:
OAuthTokenSession

Responses

Get check item

Retrieves a check item by its ID.

Authorizations:
OAuthTokenSession
path Parameters
id
required
integer

Responses

Update check item

Updates an existing check item.

Authorizations:
OAuthTokenSession
path Parameters
id
required
integer

Responses

Delete check item

Deletes a check item.

Authorizations:
OAuthTokenSession
path Parameters
id
required
integer

Responses

Create check item

Creates a new check item.

Authorizations:
OAuthTokenSession

Responses

Click Analytics

CTR metrics and click performance analytics.

CTR metrics overview with daily trend

Top clicked items with server-side pagination and sorting

Products with above-average CTR stuck on low positions (hidden gems)

Average CTR per position bucket (baseline curve)

Items with biggest CTR change vs previous period

Products with high impressions but low CTR (overexposed)

Collection

Manage collections and their schemas

Create collection

Creates a new collection with optional predefined schema.

Authorizations:
OAuthTokenSession

Responses

List of all collections

Collections serve as indexes for various objects, commonly including products, brands, or categories. Access to a specific collection is facilitated through its unique code. Each collection contains objects that must have unique IDs. Additionally, data from these collections can be utilized for displaying information on the frontend, such as in catalogs, autocomplete features, search engine results pages (SERPs), or even mobile applications

header Parameters
client-id
required
string
Example: 525ce0cee17d25297b9baaef0bd21b90

Responses

Response Schema: application/json
Array of objects (MasterShopFrontAPI.Collections.CollectionResponse DTO)

$collections

Array
name
required
string
code
string

Response samples

Content type
application/json
{
  • "collections": [
    ]
}

List predefined collections

Returns available predefined collection templates.

Authorizations:
OAuthTokenSession

Responses

Get collection

Returns details of a specific collection.

Authorizations:
OAuthTokenSession
path Parameters
id
required
integer

Responses

Update collection

Updates collection properties.

Authorizations:
OAuthTokenSession
path Parameters
id
required
integer

Responses

Delete collection

Deletes a collection and its Elastic index.

Authorizations:
OAuthTokenSession
path Parameters
id
required
integer

Responses

Get collection schema

Returns schema fields for a specific collection.

Authorizations:
OAuthTokenSession
path Parameters
id
required
integer

Responses

Recreate collection

Recreates a collection by rebuilding its Elastic index.

Authorizations:
OAuthTokenSession
path Parameters
id
required
integer

Responses

Update Elastic index

Triggers an update of the collection Elastic index.

Authorizations:
OAuthTokenSession
path Parameters
id
required
integer

Responses

Curation

Manage curations for search queries

Create new curation set with promoted and hidden products

Creates a new curation and links it to a specific collection. Allows setting promoted and hidden product IDs and associating search queries.

Authorizations:
OAuthTokenSession
Request Body schema: application/json
required
name
required
string

Name of the curation

collection_id
required
integer

ID of the linked collection

queries
required
Array of strings

Search queries triggering the curation

promoted
required
Array of strings

Product IDs to promote for this curation

hidden
required
Array of strings

Product IDs to hide for this curation

active
integer

Whether the curation is active (1=active, 0=inactive)

valid_from
string or null <date-time>

Start date/time when curation becomes active (ISO 8601 or Y-m-d H:i:s format)

valid_to
string or null <date-time>

End date/time when curation becomes inactive (ISO 8601 or Y-m-d H:i:s format)

Responses

Response Schema: application/json
required
object (UpSearch Curation )

Single curation configuration

id
required
integer

Unique ID of the curation

name
required
string

Name of the curation

active
integer

Whether the curation is active

valid_from
string or null <date-time>

Start date/time when curation becomes active (ISO 8601 format)

valid_to
string or null <date-time>

End date/time when curation becomes inactive (ISO 8601 format)

status
string
Enum: "active" "inactive" "scheduled" "expired"

Current status of the curation (active, inactive, scheduled, expired)

queries
required
Array of strings

List of search queries that trigger this curation

promoted
required
Array of objects

List of promoted items with full data

hidden
required
Array of objects

List of hidden items with full data

Request samples

Content type
application/json
{
  • "name": "Letní kampaň 2025",
  • "collection_id": 123,
  • "queries": [
    ],
  • "promoted": [
    ],
  • "hidden": [
    ],
  • "active": 1,
  • "valid_from": "2026-01-15T00:00:00",
  • "valid_to": "2026-02-28T23:59:59"
}

Response samples

Content type
application/json
{
  • "curation": {
    }
}

Query curated organic search results

Authorizations:
OAuthTokenSession
query Parameters
curation_id
required
integer
q
required
string
excluded
Array of strings

Responses

Response Schema: application/json
Array of objects (Simple Curation Item)
Array
_id
string

Elasticsearch ID

id
string

Project ID

code
string

Internal product code

name
string

Product name

title
string

Product title

image_link
string

Main product image link

price_view
object

Price view with value and currency

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get all curations in a collection

Authorizations:
OAuthTokenSession
path Parameters
id
required
integer

Responses

Response Schema: application/json
required
Array of objects (UpSearch Curation )

List of curations

Array
id
required
integer

Unique ID of the curation

name
required
string

Name of the curation

active
integer

Whether the curation is active

valid_from
string or null <date-time>

Start date/time when curation becomes active (ISO 8601 format)

valid_to
string or null <date-time>

End date/time when curation becomes inactive (ISO 8601 format)

status
string
Enum: "active" "inactive" "scheduled" "expired"

Current status of the curation (active, inactive, scheduled, expired)

queries
required
Array of strings

List of search queries that trigger this curation

promoted
required
Array of objects

List of promoted items with full data

hidden
required
Array of objects

List of hidden items with full data

Response samples

Content type
application/json
{
  • "curations": [
    ]
}

Get single curation by ID

Authorizations:
OAuthTokenSession
path Parameters
id
required
integer

Responses

Response Schema: application/json
required
object (UpSearch Curation )

Single curation configuration

id
required
integer

Unique ID of the curation

name
required
string

Name of the curation

active
integer

Whether the curation is active

valid_from
string or null <date-time>

Start date/time when curation becomes active (ISO 8601 format)

valid_to
string or null <date-time>

End date/time when curation becomes inactive (ISO 8601 format)

status
string
Enum: "active" "inactive" "scheduled" "expired"

Current status of the curation (active, inactive, scheduled, expired)

queries
required
Array of strings

List of search queries that trigger this curation

promoted
required
Array of objects

List of promoted items with full data

hidden
required
Array of objects

List of hidden items with full data

Response samples

Content type
application/json
{
  • "curation": {
    }
}

Update curation by ID

Authorizations:
OAuthTokenSession
path Parameters
id
required
integer
Request Body schema: application/json
required
id
required
integer

Unique ID of the curation

name
required
string

Name of the curation

active
integer

Whether the curation is active

valid_from
string or null <date-time>

Start date/time when curation becomes active (ISO 8601 format)

valid_to
string or null <date-time>

End date/time when curation becomes inactive (ISO 8601 format)

status
string
Enum: "active" "inactive" "scheduled" "expired"

Current status of the curation (active, inactive, scheduled, expired)

queries
required
Array of strings

List of search queries that trigger this curation

promoted
required
Array of objects

List of promoted items with full data

hidden
required
Array of objects

List of hidden items with full data

Responses

Response Schema: application/json
required
object (UpSearch Curation )

Single curation configuration

id
required
integer

Unique ID of the curation

name
required
string

Name of the curation

active
integer

Whether the curation is active

valid_from
string or null <date-time>

Start date/time when curation becomes active (ISO 8601 format)

valid_to
string or null <date-time>

End date/time when curation becomes inactive (ISO 8601 format)

status
string
Enum: "active" "inactive" "scheduled" "expired"

Current status of the curation (active, inactive, scheduled, expired)

queries
required
Array of strings

List of search queries that trigger this curation

promoted
required
Array of objects

List of promoted items with full data

hidden
required
Array of objects

List of hidden items with full data

Request samples

Content type
application/json
{
  • "id": 1234,
  • "name": "Letní kampaň 2025",
  • "active": 1,
  • "valid_from": "2026-01-15T00:00:00",
  • "valid_to": "2026-02-28T23:59:59",
  • "status": "active",
  • "queries": [
    ],
  • "promoted": [
    ],
  • "hidden": [
    ]
}

Response samples

Content type
application/json
{
  • "curation": {
    }
}

Delete curation by ID

Authorizations:
OAuthTokenSession
path Parameters
id
required
integer

Responses

Response Schema: application/json
required
Array of objects (UpSearch Curation )

List of curations

Array
id
required
integer

Unique ID of the curation

name
required
string

Name of the curation

active
integer

Whether the curation is active

valid_from
string or null <date-time>

Start date/time when curation becomes active (ISO 8601 format)

valid_to
string or null <date-time>

End date/time when curation becomes inactive (ISO 8601 format)

status
string
Enum: "active" "inactive" "scheduled" "expired"

Current status of the curation (active, inactive, scheduled, expired)

queries
required
Array of strings

List of search queries that trigger this curation

promoted
required
Array of objects

List of promoted items with full data

hidden
required
Array of objects

List of hidden items with full data

Response samples

Content type
application/json
{
  • "curations": [
    ]
}

Bulk update curations (activate/deactivate)

Authorizations:
OAuthTokenSession
Request Body schema: application/json
required
ids
Array of integers
active
integer

1 to activate, 0 to deactivate

Responses

Response Schema: application/json
updated
integer

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "active": 1
}

Response samples

Content type
application/json
{
  • "updated": 3
}

Duplicate a curation

Authorizations:
OAuthTokenSession
path Parameters
id
required
integer

Responses

Response Schema: application/json
required
object (UpSearch Curation )

Single curation configuration

id
required
integer

Unique ID of the curation

name
required
string

Name of the curation

active
integer

Whether the curation is active

valid_from
string or null <date-time>

Start date/time when curation becomes active (ISO 8601 format)

valid_to
string or null <date-time>

End date/time when curation becomes inactive (ISO 8601 format)

status
string
Enum: "active" "inactive" "scheduled" "expired"

Current status of the curation (active, inactive, scheduled, expired)

queries
required
Array of strings

List of search queries that trigger this curation

promoted
required
Array of objects

List of promoted items with full data

hidden
required
Array of objects

List of hidden items with full data

Response samples

Content type
application/json
{
  • "curation": {
    }
}

Bulk delete curations

Authorizations:
OAuthTokenSession
Request Body schema: application/json
required
ids
Array of integers

Responses

Response Schema: application/json
deleted
integer

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "deleted": 3
}

Designer

Manage designer configuration for autocomplete and search results

Uložit konfiguraci designeru pro autocomplete a SERP

Ukládá kompletní designer konfigurační objekt včetně stylů, logiky a vizuálních komponent autocomplete i výsledkové stránky. Ukládá se pro konkrétní prodejní kanál.

Authorizations:
OAuthTokenSession
path Parameters
status
required
string
Enum: "draft" "published"

draft | published

Request Body schema: application/json
required
object (Styling Proměnné)

CSS proměnné pro úpravu vzhledu autocomplete a SERP widgetu.

object (Společné vlastnosti pro autocomplete i SERP)

Konfigurační volby společné pro oba widgety – vzhled, chování tlačítek, ikon, překladů a dalších prvků.

object (Konfigurace našeptávače)

Nastavení vzhledu, struktury a chování našeptávače (autocomplete).

object (Konfigurace výsledků vyhledávání)

Nastavení struktury, navigace a vzhledu výsledkové stránky (SERP).

object (Chování vkládání do košíku)

Vlastní JavaScriptová funkce pro vložení produktu do košíku.

Responses

Response Schema: application/json
object (Styling Proměnné)

CSS proměnné pro úpravu vzhledu autocomplete a SERP widgetu.

object (Společné vlastnosti pro autocomplete i SERP)

Konfigurační volby společné pro oba widgety – vzhled, chování tlačítek, ikon, překladů a dalších prvků.

object (Konfigurace našeptávače)

Nastavení vzhledu, struktury a chování našeptávače (autocomplete).

object (Konfigurace výsledků vyhledávání)

Nastavení struktury, navigace a vzhledu výsledkové stránky (SERP).

object (Chování vkládání do košíku)

Vlastní JavaScriptová funkce pro vložení produktu do košíku.

Request samples

Content type
application/json
{
  • "style_variables": {
    },
  • "shared_config": {
    },
  • "autocomplete_config": {
    },
  • "results_config": {
    },
  • "cart_behavior": {
    }
}

Response samples

Content type
application/json
{
  • "style_variables": {
    },
  • "shared_config": {
    },
  • "autocomplete_config": {
    },
  • "results_config": {
    },
  • "cart_behavior": {
    }
}

Smazat konfiguraci designeru

Maže designer konfiguraci (draft nebo published) pro aktuální prodejní kanál.

Authorizations:
OAuthTokenSession
path Parameters
status
required
string
Enum: "draft" "published"

draft | published

Responses

Načíst konfiguraci designeru

Vrací kompletní designer konfiguraci pro aktuální projekt a prodejní kanál.

Authorizations:
OAuthTokenSession

Responses

Response Schema: application/json
object (Styling Proměnné)

CSS proměnné pro úpravu vzhledu autocomplete a SERP widgetu.

object (Společné vlastnosti pro autocomplete i SERP)

Konfigurační volby společné pro oba widgety – vzhled, chování tlačítek, ikon, překladů a dalších prvků.

object (Konfigurace našeptávače)

Nastavení vzhledu, struktury a chování našeptávače (autocomplete).

object (Konfigurace výsledků vyhledávání)

Nastavení struktury, navigace a vzhledu výsledkové stránky (SERP).

object (Chování vkládání do košíku)

Vlastní JavaScriptová funkce pro vložení produktu do košíku.

Response samples

Content type
application/json
{
  • "style_variables": {
    },
  • "shared_config": {
    },
  • "autocomplete_config": {
    },
  • "results_config": {
    },
  • "cart_behavior": {
    }
}

Načíst konfigurační JSON pro upSearch

Vrací konfiguraci pro UpSearch autocomplete, výsledky a styly.

Authorizations:
OAuthTokenSession
path Parameters
status
required
string
Enum: "published" "draft"

published | draft

Responses

Response Schema: application/json
object
object

Konfigurační objekt autocomplete (sloučený shared + autocomplete config)

serp
string

JSON serializovaná verze autocomplete konfigurace

css
string

CSS proměnné jako