New Visual Search Session
const url = 'https://api.vviinn.com/search/session?excluded%5B%5D=brand%3ANike%2CPuma&excluded%5B%5D=custom_label_0%3Asummer';const form = new FormData();form.append('image', 'file');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url 'https://api.vviinn.com/search/session?excluded%5B%5D=brand%3ANike%2CPuma&excluded%5B%5D=custom_label_0%3Asummer' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: multipart/form-data' \ --form image=@fileStarts a reusable search session for a one image.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”object
Responses
Section titled “Responses”Success
object
object
This field is superseded by the entity type and therefore deprecated.
The API usually returns products; it can also return entities representing something else.
To enable different handling of these entities, the API uses an entity-type to distinguish between them, namely:
- A
productentity represents a product in the catalog. - A
contententity contains information relevant to a user, e.g., trends, opening hours. - A
listentity comprises a collection of distinguishable items, e.g., a category page.
Link to the product detail page; on a grouped product, the link to the page of the group where there is one
object
object
object
object
The base price per measure is derived by adjusting the product’s total cost to a standardized unit of measurement, making it easier to compare products of varying volumes.
object
The base price per measure is derived by adjusting the product’s total cost to a standardized unit of measurement, making it easier to compare products of varying volumes.
object
object
object
object
The product’s values for the attributes named in siblings.options, keyed by the
attribute’s name; null where the product has no value. In addition, the attributes that
every variant carries independently of the options; each of them is absent where the product
has no value.
object
A color. hexCode, rgb and family are present only if they are known for the color.
object
object
The other variants the site groups with this product (for example the other colors and sizes
of one shirt) and the attributes that vary across the product and these variants together.
All of them share the product’s groupId.
It is null if the product was not grouped with other variants. Variants are grouped only
if the site groups variants, and only among the results of a search or a recommendation.
object
The attributes that vary across the group, each with the distinct values it takes. The values are those of this product and its siblings together, so a value that only this product has is listed as well. The list is empty if no attribute varies.
object
The attribute’s name. The product’s attributes and the attributes of every sibling
have an entry under this name.
The distinct values of the attribute. They do not say which combinations of values exist;
the attributes of the product and of each sibling do.
The other variants grouped with this product that are relevant to the request.
A variant grouped with the product.
object
All images of the variant, in the order of the catalog. The list can be empty.
object
The variant’s values for the attributes named in siblings.options, keyed by the
attribute’s name; null where the variant has no value. In addition, the attributes that
every variant carries independently of the options; each of them is absent where the variant
has no value.
object
A color. hexCode, rgb and family are present only if they are known for the color.
object
object
object
object
object
object
object
object
object
object
object
object
object
object
Example
{ "value": [ { "kind": "product", "entityType": "product", "groupId": "55fc5f71d6362321cb93b82b387e2f32", "productId": "55fc5f71d6362321cb93b82b387e2f32", "title": "Livingwalls Fototapete Walls by Patel iconic 3", "deeplink": "http://mainUrl/site/5/product/55fc5f71d6362321cb93b82b387e2f32/details", "brand": "Fender", "productType": "guitar", "image": { "original": "http://mainUrl/image.jpg", "thumbnail": "http://mainUrl/thumbnail-image.jpg" }, "images": [ { "original": "http://mainUrl/image.jpg", "thumbnail": "http://mainUrl/thumbnail-image.jpg" } ], "price": { "actual": 19.9, "sale": 19.9 }, "basePrice": { "actual": { "price": 15.92, "quantity": 100, "measure": "ml" }, "sale": { "price": 15.92, "quantity": 100, "measure": "ml" } }, "energyEfficiencyClass": "A+++", "minEnergyEfficiencyClass": "A+++", "maxEnergyEfficiencyClass": "A+++", "energyCertifications": [ { "certificationClass": "A+++", "classRange": { "min": "A+++", "max": "A+++" } } ], "attributes": { "color": [ { "value": "beige > #c7b3a8", "name": "beige", "hexCode": "#c7b3a8", "rgb": { "red": 199, "green": 179, "blue": 168 }, "family": "beige" } ], "size": "M", "link": "https://www.example.com/shirt?color=beige&size=M" }, "siblings": { "options": [ { "name": "size", "values": [ "M", "L" ] } ], "items": [ { "productId": "7b0a1c7f5d2e4a6f9c3b8d1e2f4a6c8e", "images": [ { "original": "http://mainUrl/image.jpg", "thumbnail": "http://mainUrl/thumbnail-image.jpg" } ], "attributes": { "color": [ { "value": "blau", "name": "blau" } ], "size": "L", "link": "https://www.example.com/shirt?color=blau&size=L" } } ] } } ], "type": "array", "searchArea": { "method": "POST" }, "uploadHighResolutionImage": { "method": "POST" }, "filters": { "type": "object", "value": { "categories": [ { "method": "POST" } ] } }, "links": { "self": { "method": "POST", "href": "/search/session/62cd4392853023-58137863" } }, "detectedObjects": [ { "value": { "rectangle": { "left": 0, "top": 0.3641, "width": 0.94, "height": 0.54175 } } } ]}ProductSearch exception
Example
{ "message": "Could not start search session", "data": "", "debug": "Passed images count to this endpoint are invalid or not enough."}Authentication Error
Example
{ "message": "Authentication Error"}Authorization Error
Example
{ "message": "Authorization Error"}