Qon logo
API docs by Redocly

QON REST API v3 (1.0.11)

Download OpenAPI specification:

E-mail: heldesk@quarticon.com License: Apache 2.0

API version

Actual API version is 1.0

Version Supported Description
1.0 Yes, Actual Initial smartSearchApi version

Format

The entire API uses JSON encoded as UTF-8

API limitations

There is not any API request limitations yet.

API request cache

Internal

Each API response is internally cached for 15 minutes based on the query parameters. The cache is cleared when critical module settings are changed.

Cache-Control

Each API response use Cache-Control set to private, max-age:900, max-stale:3600

Error handling

Both successful and error responses will be returned as JSON.

Correct answers will return a response with HTTP code 2xx status. If the request cannot be handled correctly, HTTP response codes will be 4xx.

In response to an errored request, JSON will still be returned, in which we will find information about the error. There will also be the error code, a human-readable description and a link to where we can find a solution to the problem.

{
    "error": "Error ID",
    "message": "Short error message",
    "detail": "Full error message",
    "help": "Help URL"
    "timestamp": "Date/time",
    "errors": [
        {
            "code": "Error code"
            "message": "Error message",
            "details": "Error details",
            "message": "Help URL",
        },
    "version": "API version",
    "requestId": "Request ID",
    "debugKey": "Debug key",
    ]
}

Catalog module

The Catalog module primarily facilitates the retrieval of product data. To utilize this module, it's necessary to import the catalog into the QON panel. All endpoints within this group will require both a customer symbol and a catalog ID to be usable.

Find out more

Get product details from catalog

This endpoint allows you to access product data, which is retrieved from the customer catalog based on the product ID. Product information is limited to the product attributes allowed in the configuration for the given catalog (configuration is possible in the QON panel).
With this solution, you can get product information practically anywhere you can send an HTTP request.

Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string [ 3 .. 16 ] characters
Example: 10d76328f6095b85

Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab

catalogId
required
string >= 3 characters
Example: 63ee75ac6d5c5

Product catalog identifier, available from the QON panel catalog list

productId
required
string >= 3 characters
Example: AUS350

Product identifier in the specified product catalog. Product ID can be found in the QON panel in the catalog view or in products section searching response

Responses

Response samples

Content type
application/vnd.qon+json
Example
{}

Search module

The Search module encompasses all endpoints required to enable the use of the QON search engine. This includes endpoints specifically designed for product search and returning popular search phrases, as well as those responsible for generating user-friendly features such as a list of possible sort options and faceted menus. To take advantage of this module, it will be necessary to configure a search instance in the QON panel. All endpoints within this group will require both a customer symbol and a search ID to be usable.

Find out more

Get defined sorting capabilities for the Search Instance

This endpoint returns the sorting methods defined in the customer panel. The order of returned results are based on the settings in the panel.

Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string [ 3 .. 16 ] characters
Example: 10d76328f6095b85

Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab

searchId
required
string >= 3 characters
Example: 55e4fb1425f79b21de0d63e0674b057c

Search Instance ID, to be found in the QON panel

Responses

Response samples

Content type
application/vnd.qon+json
{
  • "meta": {
    },
  • "sort": [
    ]
}

Get suggested phrases for the currently entered query

This endpoint enables the retrieval of suggested phrases or hints in response to the current query input.
We recommend using the returned response after a user has entered their search terms, in order to suggest what they might want to look for. If the query is left blank, we will return what we believe to be the best suggestions.
These suggestions are crafted based on specific fields in the product catalog as indicated by the client. The configuration of fields used to generate suggestions can be found in the panel.

Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string [ 3 .. 16 ] characters
Example: 10d76328f6095b85

Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab

searchId
required
string >= 3 characters
Example: 55e4fb1425f79b21de0d63e0674b057c

Search Instance ID, to be found in the QON panel

query Parameters
q
string <= 255 characters
Example: q=Koszula męska

Search phrase, suggestions are based on it

Responses

Response samples

Content type
application/vnd.qon+json
Example
{}

Get paged search results for a query phrase with filters

This is the main endpoint of the search module and it is responsible for matching search results as closely as possible to what the user is looking for.
To utilize this search functionality you must configure a search instance in the panel. It is recommended to set the method of sorting results and specify which search fields are more or less important. You can configure synonyms, i.e. phrases that will replace others at the search stage or that will be used for invariant and blocked phrases.
The data returned in the response are the products from the client's specified product catalog that best match the user's filtered query (assigning the catalog to the search instance is one of the configuration elements).

Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string [ 3 .. 16 ] characters
Example: 10d76328f6095b85

Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab

searchId
required
string >= 3 characters
Example: 55e4fb1425f79b21de0d63e0674b057c

Search Instance ID, to be found in the QON panel

query Parameters
q
string <= 255 characters
Example: q=Koszula męska

Search phrase, suggestions are based on it

s
string [ 3 .. 32 ] characters
Default: "default"

Id of sort strategy

p
integer
Default: 0

Search results page number

pl
number or null >= 0
Default: null
Example: pl=9.99

Set the minimum price of found products. Value should be lower than the max price value (ph parameter). If the value of the pl parameter is empty, no minimum price limit will be set.

ph
number or null
Default: null
Example: ph=310

Set the maximum price of products, must be higher than minimal price pl. If value is null no maximum price limit will be set.

Array of CheckboxFilter (strings) or RangeFilter (object)
Example: f[field_name]=["biała","szara"]

Search filter array

Responses

Response samples

Content type
application/vnd.qon+json
Example
{}

Redirect to the product page by registering click in the search result

To accurately report on search result effectiveness, we need to receive information about which products have been clicked on. This endpoint enables user redirection to the product page via the QON server, which records information about which product from which the search was clicked. The product link can be found in the description of the returned products under the link_click attribute. If we want to create the link ourselves, we need to ensure that we indicate the correct identifiers and use the transformed base64 URL address. To obtain a safeBase64Url, we need to generate a base64 from the address we want to redirect to, then replace + with - and / with _.

Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string [ 3 .. 16 ] characters
Example: 10d76328f6095b85

Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab

searchId
required
string >= 3 characters
Example: 55e4fb1425f79b21de0d63e0674b057c

Search Instance ID, to be found in the QON panel

productId
required
string >= 3 characters
Example: AUS350

Product identifier in the specified product catalog. Product ID can be found in the QON panel in the catalog view or in products section searching response

requestId
required
string >= 3 characters
Example: 60a27e9f86c32345ec4cb95ce4c2976

RequestId returned in meta section searching response

safeBase64Url
required
string >= 5 characters
Example: aHR0cHM6Ly93d3cud2l0dGNoZW4uY29tL3BpZXJzaW93a2EscDEyMDk2NDI_aW5zdGFuY2VfaWQ9ODQ4NTg3

Safe base64 from target URL. It is base64 from the address to redirect to, then replaced + to - ans / to _.

Responses

Response samples

Content type
application/vnd.qon+json
{
  • "error": "auth-01",
  • "message": "Request is not authorized",
  • "detail": "Check that your authorization code and customer symbol are correct. If you use whitelist to enable searching check if your request header contains correct referrer.",
  • "help": "http://help.quarticon.com",
  • "timestamp": "2023-01-12T17:30:10Z",
  • "errors": [
    ],
  • "version": "versionUnknown",
  • "requestId": "requestIdUnknown",
  • "debugKey": null
}

Get aggregated data to create facet menu

The purpose of this endpoint is to return data that will allow the creation of a faceted menu for current search results.
The response will be a sorted list of descriptions for each successive filtering option for the faceted menu. The configuration of the sequence of allowed filtering and the fields on which this filtering is based can be found in the QON panel. The response enables the construction of filters, from category trees to selection lists, to a simple price filter.
The returned response is closely tied to search parameters, which is why the endpoint accepts so many parameters.

Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string [ 3 .. 16 ] characters
Example: 10d76328f6095b85

Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab

searchId
required
string >= 3 characters
Example: 55e4fb1425f79b21de0d63e0674b057c

Search Instance ID, to be found in the QON panel

query Parameters
q
string <= 255 characters
Example: q=Koszula męska

Search phrase, suggestions are based on it

Array of CheckboxFilter (strings) or RangeFilter (object)
Example: f[field_name]=["biała","szara"]

Search filter array

pl
number or null >= 0
Default: null
Example: pl=9.99

Set the minimum price of found products. Value should be lower than the max price value (ph parameter). If the value of the pl parameter is empty, no minimum price limit will be set.

ph
number or null
Default: null
Example: ph=310

Set the maximum price of products, must be higher than minimal price pl. If value is null no maximum price limit will be set.

Responses

Response samples

Content type
application/vnd.qon+json
Example
{
  • "meta": {
    },
  • "aggregations": [
    ]
}

Get front application settings

This endpoint returns a list of the labels and settings which are useful in front application.

Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string [ 3 .. 16 ] characters
Example: 10d76328f6095b85

Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab

searchId
required
string >= 3 characters
Example: 55e4fb1425f79b21de0d63e0674b057c

Search Instance ID, to be found in the QON panel

Responses

Response samples

Content type
application/vnd.qon+json
{
  • "meta": {
    },
  • "settings": {
    },
  • "labels": {
    }
}

Recommendation module

The recommendation module is responsible for generating lists of recommended products in the context of a user or a specific product. It supports both personalized user-based recommendations and product-based recommendations, including similar and complementary products. Each API call allows control over the scope of recommendations through filtering parameters. Available filters include product categories and price ranges (also percentage-based, relative to a base price, e.g. the price of the product for which the recommendation frame is generated). The configuration of recommendation frame logic is available in the administration panel.

Find out more

Get recommended products list

This is the main endpoint responsible for generating a list of recommended products. To use this functionality, a recommendation frame must be configured in the administration panel and assigned to a specific placement. In addition to the filters defined in the panel, it is possible to pass additional filters at the request level when retrieving a recommendation frame. It is crucial to provide user-identifying data (such as cookies, device identifiers, etc.). The returned recommendations are generated from the user-specific product catalog defined in the panel configuration. One of the following parameters must be provided: cookie or userId.

Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string [ 3 .. 16 ] characters
Example: 10d76328f6095b85

Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab

placementId
required
string [ 3 .. 32 ] characters
Example: 32s6n

Placement ID, to be found in the QON panel (with or without qS prefix)

query Parameters
cookie
string [ 3 .. 64 ] characters
Example: cookie=93c36c155ca40636

User cookie for whom the recommendation frame is generated. Either cookie or deviceId must be provided.

deviceId
string [ 3 .. 64 ] characters
Example: deviceId=d-32_1131

Device identifier of the user for whom the recommendation frame is generated. Either cookie or deviceId must be provided.

userId
string [ 3 .. 64 ] characters
Example: userId=user-321

Id of the user for whom the recommendation frame will be presented

requestGroupId
string [ 3 .. 64 ] characters
Example: requestGroupId=req-2345678asdfg

Request group ID in which the system will attempt to exclude duplicates. Applicable only when the deduplicate flag is enabled.

deduplicate
boolean
Example: deduplicate=true

Flag enabling the exclusion of duplicates within request groups. Allowed values: [true, false, 0, 1, "0", "1", "true", "false"]

filterProduct
string [ 2 .. 128 ] characters
Example: filterProduct=product-id-2321,product-id-23

A list of product identifiers that will be filtered out from the returned product list. If you want to provide more than one product identifier, separate them with commas.

filterCategory
string [ 2 .. 128 ] characters
Example: filterCategory=category_4,category_1|category_2,!category_3

A set of category identifiers used to filter the returned recommendation list. Categories can be negated by prefixing them with the ! character. Filtering logic can be provided, where , acts as an AND operator and | acts as an OR operator. For example, the filter category_4,category_1|category_2,!category_3 means ("category_4") AND ("category_1" OR "category_2") AND (NOT "category_3"). It is important to note that the filtering configured in the administration panel will also be applied in addition to this.

baseProduct
string [ 2 .. 128 ] characters
Example: baseProduct=product-id-12

A list of product identifiers for which the recommendation frame will be generated. The frame must be of a specific type, which can be configured in the administration panel.

priceMin
number
Example: priceMin=200.22

Minimum price value of products returned in the recommended product list. It must be lower than the maximum price value if priceMax is provided. Please note that price filtering will also be affected by the percentage-based price filter, if configured, as well as by the recommendation frame configuration defined in the administration panel.

priceMax
number
Example: priceMax=1200.43

Maximum price value of products returned in the recommended product list. It must be higher than the minimum price value if priceMin is provided. Please note that price filtering will also be affected by the percentage-based price filter, if configured, as well as by the recommendation frame configuration defined in the administration panel.

pricePercentMin
number
Example: pricePercentMin=80

Defines the minimum price of returned products based on a percentage of the base price. The base price for product-based recommendation lists is calculated as the average price of the referenced product(s). For user-based recommendation frames, the base price is calculated as the average price of recently purchased or viewed products. Setting the minimum price percentage filter to 80% will result in a calculated minimum price (e.g. for a product priced at 1000, the minimum price filter will be set to 800). Price filters, percentage-based price filters, and filters configured in the administration panel are all applied cumulatively.

pricePercentMax
number
Example: pricePercentMax=120

Defines the maximum price of returned products based on a percentage of the base price. The base price for product-based recommendation lists is calculated as the average price of the referenced product(s). For user-based recommendation frames, the base price is calculated as the average price of recently purchased or viewed products. Setting the maximum price percentage filter to 120% will result in a calculated maximum price (e.g. for a product priced at 1000, the maximum price filter will be set to 1200). Price filters, percentage-based price filters, and filters configured in the administration panel are all applied cumulatively.

Responses

Response samples

Content type
application/vnd.qon+json
Example
{}

Tracking module

The Tracking module aggregates all currently available endpoints responsible for retrieving traffic data. This functionality is integral to the smooth operation of our solution, as it relies on the provision of customer behavior data from in-store interactions. The information collected helps generate detailed reports and expand the configuration possibilities of other modules, such as enabling product popularity-based sorting in search results.

Find out more

Send purchase information

To properly report transactions and to present best-sellers products, we need information about completed transactions in the store. This endpoint enables you to inform us of such transactions. Each transaction should have its own unique identifier and should be assigned to a user with a unique identifier.

Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string [ 3 .. 16 ] characters
Example: 10d76328f6095b85

Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab

Request Body schema: application/json
required
transactionId
required
string

Transaction ID

required
Array of objects (BasketProduct)

Array of products

userId
required
string

User ID

transactionDate
required
string <Y-m-d H:i:s>

Transaction date

referrer
string

Web URL triggered this request

cookie
string

Customer ID stored in cookies

currency
string

Transaction currency, for instance 'PLN'

Responses

Request samples

Content type
application/json
{
  • "transactionId": "Postman-TEST-02",
  • "basket": [
    ],
  • "userId": "postmanTest",
  • "transactionDate": "2023-04-23 10:05:12",
  • "referrer": "string",
  • "cookie": "cookiePtz",
  • "currency": "PLN"
}

Response samples

Content type
application/vnd.qon+json
[ ]

Send click information

This endpoint collects click events information. This data is used to report on the performance of our tools.

Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string [ 3 .. 16 ] characters
Example: 10d76328f6095b85

Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab

Request Body schema: application/json
required
event_type
required
string
Enum: "click" "impression" "ui_interaction" "search_submit"
required
object

Where the event occurred?

required
object

What service the event refers to?

required
object

What element does the event concern?

required
object

How was click target presented?

metadata
object

Optional metadata for request. Each property of this object is a string with max length of 64.

Responses

Request samples

Content type
application/json
{
  • "event_type": "click",
  • "env": {
    },
  • "service": {
    },
  • "target": {
    },
  • "ui": {
    },
  • "metadata": {
    }
}

Response samples

Content type
text/html
Send information about viewing the product 
This endpoint collects product view events generated in the e-commerce store. The data is used for analytics, performance measurement, and improving recommendation and tracking tools.


path Parameters
customerSymbol
required
string  [ 3 .. 16 ] characters 
 
 Example:  10d76328f6095b85
Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab


Request Body schema: application/json
required
 Any of 
productId
required
string  [ 3 .. 32 ] characters 
 
Identifier of the viewed product.


cookie
required
string  <= 64 characters 
 
Cookie identifying the user. Required if deviceId is not provided.


deviceId
string  <= 256 characters 
 
Device identifier. Required if cookie is not provided.


userId
string  [ 3 .. 32 ] characters 
 
Identifier of the user who viewed the product.


timestamp
string
 
View timestamp. Supported formats:


    

  • ISO 8601: "YYYY-MM-DDTHH:mm:ssZ"
    • 

  • ISO 8601 with offset: "YYYY-MM-DDTHH:mm:ss+0100"
    • 

  • "YYYY-MM-DD HH:mm:ss"
    • 



referrer
string  <= 256 characters 
 
Web URL that triggered this request


Responses
 Request samples 
Content type
application/json
{
  • "productId": "productId122",
  • "userId": "usr-112",
  • "cookie": "62a0cf8d0e3b412a1e29",
  • "device": "a21db5913be1dbe",
  • "timestamp": "2025-05-21T12:47:27Z"
}
 Response samples 
Content type
application/vnd.qon+json
[ ]
Stylist module
The stylist module is a set of endpoints dedicated to clients from the fashion industry. It contains tools that
allow you to compose sets of clothes using products from the customer's catalog based on photos showing fashion
styling. To take advantage of this module, it will be necessary to configure a stylist instance in the QON panel.
All endpoints within this group will require both a customer symbol and a sylist instance ID to be usable.


Find out more
Get "Get The Look" product sets from catalog 
This endpoint allows you to access products data, which is retrieved from the customer catalog based on the stylist instance ID and stylization ID.

With this solution, you can get "Get The Look" information practically anywhere you can send an HTTP request.

Returned products are grouped into sets so that you can view subsequent full sets.


Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string  [ 3 .. 16 ] characters 
 
 Example:  10d76328f6095b85
Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab


stylistInstanceId
required
string  >= 3 characters 
 
 Example:  55e4fb1425f79b21de0d63e0674b057c
Stylist instance ID, to be found in the QON panel


stylizationId
required
string  >= 3 characters 
 
 Example:  63ee75ac6d5c5
Stylization identifier, available from the QON panel


Responses
 Response samples 
Content type
application/vnd.qon+json
Example
{}
Get "Get The Look" products from catalog 
This endpoint allows you to access products data, which is retrieved from the customer catalog based on the stylist instance ID and stylization ID.

With this solution, you can get "Get The Look" information practically anywhere you can send an HTTP request.

Returned products are grouped into categories, so you can scroll products at the category level - enable you to select a product for the rest of the styling.


Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string  [ 3 .. 16 ] characters 
 
 Example:  10d76328f6095b85
Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab


stylistInstanceId
required
string  >= 3 characters 
 
 Example:  55e4fb1425f79b21de0d63e0674b057c
Stylist instance ID, to be found in the QON panel


stylizationId
required
string  >= 3 characters 
 
 Example:  63ee75ac6d5c5
Stylization identifier, available from the QON panel


Responses
 Response samples 
Content type
application/vnd.qon+json
Example
{}
Complete "The look" by product sets from catalog 
This endpoint allows you to access product data that is retrieved from the customer catalog based on the stylist instance ID and product ID.

With this solution, you can get information about products that complement your look virtually anywhere you can send an HTTP request.

Returned products are grouped into sets, so you can browse subsequent full sets.


Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string  [ 3 .. 16 ] characters 
 
 Example:  10d76328f6095b85
Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab


stylistInstanceId
required
string  >= 3 characters 
 
 Example:  55e4fb1425f79b21de0d63e0674b057c
Stylist instance ID, to be found in the QON panel


productId
required
string  >= 3 characters 
 
 Example:  AUS350
Product identifier in the specified product catalog. Product ID can be found in the QON panel in the catalog view or in products section searching response


Responses
 Response samples 
Content type
application/vnd.qon+json
Example
{}
Complete "The look" by product from catalog 
This endpoint allows you to access product data that is retrieved from the customer catalog based on the stylist instance ID and product ID.

With this solution, you can get information about products that complement your look virtually anywhere you can send an HTTP request.

Returned products are grouped by products category.


Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string  [ 3 .. 16 ] characters 
 
 Example:  10d76328f6095b85
Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab


stylistInstanceId
required
string  >= 3 characters 
 
 Example:  55e4fb1425f79b21de0d63e0674b057c
Stylist instance ID, to be found in the QON panel


productId
required
string  >= 3 characters 
 
 Example:  AUS350
Product identifier in the specified product catalog. Product ID can be found in the QON panel in the catalog view or in products section searching response


Responses
 Response samples 
Content type
application/vnd.qon+json
Example
{}
Redirect to the product page by registering click in the get the look result 
To accurately report on get the look result effectiveness, we need to receive information about which products have been
clicked on. This endpoint enables user redirection to the product page via the QON server, which records information
about which product from which the get the look was clicked. The product link can be found in the description of the
returned products under the link_click attribute. If we want to create the link ourselves, we need to ensure that
we indicate the correct identifiers and use the transformed base64 URL address. To obtain a safeBase64Url, we need
to generate a base64 from the address we want to redirect to, then replace + with - and / with _.


Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string  [ 3 .. 16 ] characters 
 
 Example:  10d76328f6095b85
Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab


stylistInstanceId
required
string  >= 3 characters 
 
 Example:  55e4fb1425f79b21de0d63e0674b057c
Stylist instance ID, to be found in the QON panel


productId
required
string  >= 3 characters 
 
 Example:  AUS350
Product identifier in the specified product catalog. Product ID can be found in the QON panel in the catalog view or in products section searching response


requestId
required
string  >= 3 characters 
 
 Example:  60a27e9f86c32345ec4cb95ce4c2976
RequestId returned in meta section searching response


safeBase64Url
required
string  >= 5 characters 
 
 Example:  aHR0cHM6Ly93d3cud2l0dGNoZW4uY29tL3BpZXJzaW93a2EscDEyMDk2NDI_aW5zdGFuY2VfaWQ9ODQ4NTg3
Safe base64 from target URL. It is base64 from the address to redirect to, then replaced + to - ans / to _.


Responses
 Response samples 
Content type
application/vnd.qon+json
{
  • "error": "auth-01",
  • "message": "Request is not authorized",
  • "detail": "Check that your authorization code and customer symbol are correct. If you use whitelist to enable searching check if your request header contains correct referrer.",
  • "help": "http://help.quarticon.com",
  • "timestamp": "2023-01-12T17:30:10Z",
  • "errors": [
    ],
  • "version": "versionUnknown",
  • "requestId": "requestIdUnknown",
  • "debugKey": null
}
SocialProof module
The SocialProof module is a set of endpoints, that return statistics, how many times given product was viewed or purchase.
All endpoints within this group will require both a customer symbol and a product ID.


Find out more
Get product purchase statistics 
This endpoint returns count of given product purchases.


Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string  [ 3 .. 16 ] characters 
 
 Example:  10d76328f6095b85
Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab


productId
required
string  >= 3 characters 
 
 Example:  AUS350
Product identifier in the specified product catalog. Product ID can be found in the QON panel in the catalog view or in products section searching response


Request Body schema: application/json
optional
object
 
Interval from which data should be returned. Default is P0D, meaning data from today.


Responses
 Request samples 
Content type
application/json
{
  • "interval": {
    }
}
 Response samples 
Content type
application/vnd.qon+json
{
  • "meta": {
    },
  • "data": {
    }
}
Get product view statistics 
This endpoint returns count of given product views.


Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string  [ 3 .. 16 ] characters 
 
 Example:  10d76328f6095b85
Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab


productId
required
string  >= 3 characters 
 
 Example:  AUS350
Product identifier in the specified product catalog. Product ID can be found in the QON panel in the catalog view or in products section searching response


Request Body schema: application/json
optional
object
 
Interval from which data should be returned. Default is P0D, meaning data from today.


Responses
 Request samples 
Content type
application/json
{
  • "interval": {
    }
}
 Response samples 
Content type
application/vnd.qon+json
{
  • "meta": {
    },
  • "data": {
    }
}
SocialStream module
The SocialStream module is a set of endpoints, that return configuration and posts/products list for Your SocialStream instances.
All endpoints within this group will require a customer symbol. You may also need Your SocialStream instance ID.


Find out more
Get SocialStream configuration 
This endpoint returns configuration of given Social Stream instance.


Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string  [ 3 .. 16 ] characters 
 
 Example:  10d76328f6095b85
Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab


socialStreamId
required
string  = 32 characters 
 
 Example:  3391ae66c10367bf3ff3f2dddd9fc3f3
SocialStream instance ID, to be found in the QON panel


Responses
 Response samples 
Content type
application/vnd.qon+json
{}
Get SocialStream grid 
This endpoint returns two lists for generating a grid on your page:


    

  • posts that has assign products
    • 

  • products assigned to posts
    • 



Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string  [ 3 .. 16 ] characters 
 
 Example:  10d76328f6095b85
Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab


socialStreamId
required
string  = 32 characters 
 
 Example:  3391ae66c10367bf3ff3f2dddd9fc3f3
SocialStream instance ID, to be found in the QON panel


Responses
 Response samples 
Content type
application/vnd.qon+json
{}
Get list of SocialStream instances 
This endpoint returns list of Your SocialStream instances, that have showOnList property set to TRUE


Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string  [ 3 .. 16 ] characters 
 
 Example:  10d76328f6095b85
Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab


Responses
 Response samples 
Content type
application/vnd.qon+json
[]
Lookbook module
The Lookbook module is a set of endpoints, that return configuration and defined product assignment for Your Lookbook instances.
All endpoints within this group will require a customer symbol and Lookbook instance ID.


Find out more
Get Lookbook configuration 
This endpoint returns configuration of given Lookbook instance.


Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string  [ 3 .. 16 ] characters 
 
 Example:  10d76328f6095b85
Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab


lookbookId
required
string  = 32 characters 
 
 Example:  3391ae66c10367bf3ff3f2dddd9fc3f3
Lookbook instance ID, to be found in the QON panel


Responses
 Response samples 
Content type
application/vnd.qon+json
{}
Get Lookbook grid 
This endpoint returns list of photos in your lookbook instance, list of hotspots defined for them and list of products assigned to each hotspot.


Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string  [ 3 .. 16 ] characters 
 
 Example:  10d76328f6095b85
Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab


lookbookId
required
string  = 32 characters 
 
 Example:  3391ae66c10367bf3ff3f2dddd9fc3f3
Lookbook instance ID, to be found in the QON panel


Responses
 Response samples 
Content type
application/vnd.qon+json
[]
Get Lookbook item 
This endpoint returns given host image item, list of hotspots defined for it and list of products assigned to each hotspot.


Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string  [ 3 .. 16 ] characters 
 
 Example:  10d76328f6095b85
Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab


lookbookId
required
string  = 32 characters 
 
 Example:  3391ae66c10367bf3ff3f2dddd9fc3f3
Lookbook instance ID, to be found in the QON panel


hostImageItemId
required
string
 
 Example:  3391cd
ID of catalog item being used as a source for a photo in lookbook. Can be found in QON panel -> Lookbook, at Photos tab in Your lookbook instance details.


Responses
 Response samples 
Content type
application/vnd.qon+json
{}
Get Lookbook product 
This endpoint returns list of photos in your lookbook instance, list of hotspots defined for them and list of products assigned to each hotspot. The list is limited to photos, that have assigned given product.


Authorizations:
ApiKeyAuth
path Parameters
customerSymbol
required
string  [ 3 .. 16 ] characters 
 
 Example:  10d76328f6095b85
Customer symbol on the QON platform. You can find it in the panel in the API key configuration tab


lookbookId
required
string  = 32 characters 
 
 Example:  3391ae66c10367bf3ff3f2dddd9fc3f3
Lookbook instance ID, to be found in the QON panel


productId
required
string  >= 3 characters 
 
 Example:  AUS350
Product identifier in the specified product catalog. Product ID can be found in the QON panel in the catalog view or in products section searching response


Responses
 Response samples 
Content type
application/vnd.qon+json
[]