{ "info": { "_postman_id": "180dc493-9247-486a-aab3-234d96cd1309", "name": "Voyado Elevate Web API Playground", "description": "Contact Support:\n Email: support@voyado.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "22650084" }, "item": [ { "name": "api", "item": [ { "name": "v2", "item": [ { "name": "panels", "item": [ { "name": "{panelPath}", "item": [ { "name": "Query configured eSales panels", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/panels/:panelPath?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=&commodo_b=&dolore_7=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "panels", ":panelPath" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" }, { "key": "commodo_b", "value": "", "description": "Free form query parameters as json object" }, { "key": "dolore_7", "value": "", "description": "Free form query parameters as json object" } ], "variable": [ { "key": "panelPath", "value": "" } ] }, "description": "Panel queries are the main way of fetching results, such as products or ads from eSales. Panels can be queried through the Web API when the panel hierarchy for your site has been published. A successful query returns the panel content in flattened and serialised JSON format.\n\nParameters that have not been set in panel configuration or have a default value in pre-defined panels has to be sent as arguments.\n" }, "response": [ { "name": "Returns panel content flattened and serialized to JSON", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/panels/:panelPath?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=&commodo_b=&dolore_7=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "panels", ":panelPath" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" }, { "key": "commodo_b", "value": "", "description": "Free form query parameters as json object" }, { "key": "dolore_7", "value": "", "description": "Free form query parameters as json object" } ], "variable": [ { "key": "panelPath" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Invalid or missing arguments for this panel.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/panels/:panelPath?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=&commodo_b=&dolore_7=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "panels", ":panelPath" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" }, { "key": "commodo_b", "value": "", "description": "Free form query parameters as json object" }, { "key": "dolore_7", "value": "", "description": "Free form query parameters as json object" } ], "variable": [ { "key": "panelPath" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Panel not found or not public.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/panels/:panelPath?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=&commodo_b=&dolore_7=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "panels", ":panelPath" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" }, { "key": "commodo_b", "value": "", "description": "Free form query parameters as json object" }, { "key": "dolore_7", "value": "", "description": "Free form query parameters as json object" } ], "variable": [ { "key": "panelPath" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Service unavailable, no products found in cluster.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/panels/:panelPath?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=&commodo_b=&dolore_7=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "panels", ":panelPath" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" }, { "key": "commodo_b", "value": "", "description": "Free form query parameters as json object" }, { "key": "dolore_7", "value": "", "description": "Free form query parameters as json object" } ], "variable": [ { "key": "panelPath" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "dynamic-pages", "item": [ { "name": "Query multiple panels without configured zones", "request": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"panel\": \"\",\n \"name\": \"\",\n \"subpanels\": [\n {\n \"name\": \"\",\n \"panel\": \"\",\n \"arguments\": {}\n },\n {\n \"name\": \"\",\n \"panel\": \"\",\n \"arguments\": {}\n }\n ],\n \"arguments\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/dynamic-pages?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "dynamic-pages" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] }, "description": "Dynamic pages is a concept which makes it possible to retrieve content from several panels at once, without pre-defining a zone for each combination of panels that might be called at once. A dynamic page must be called server side.\n\nA query to a dynamic page includes arguments to the sub-panels of that page. This enables the re-use of a dynamic page by supplying different arguments to the sub-panel. A successful query returns the dynamic page content in flattened and serialised JSON format. When querying a dynamic page via the Web API, an Api-Key header is required for authentication.\n" }, "response": [ { "name": "Return panel content flattened and serialized to JSON", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"panel\": \"\",\n \"name\": \"\",\n \"subpanels\": [\n {\n \"name\": \"\",\n \"panel\": \"\",\n \"arguments\": {}\n },\n {\n \"name\": \"\",\n \"panel\": \"\",\n \"arguments\": {}\n }\n ],\n \"arguments\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/dynamic-pages?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "dynamic-pages" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Invalid or missing arguments to any of the requested panels.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"panel\": \"\",\n \"name\": \"\",\n \"subpanels\": [\n {\n \"name\": \"\",\n \"panel\": \"\",\n \"arguments\": {}\n },\n {\n \"name\": \"\",\n \"panel\": \"\",\n \"arguments\": {}\n }\n ],\n \"arguments\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/dynamic-pages?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "dynamic-pages" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Api-Key could not be validated", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"panel\": \"\",\n \"name\": \"\",\n \"subpanels\": [\n {\n \"name\": \"\",\n \"panel\": \"\",\n \"arguments\": {}\n },\n {\n \"name\": \"\",\n \"panel\": \"\",\n \"arguments\": {}\n }\n ],\n \"arguments\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/dynamic-pages?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "dynamic-pages" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Panel not found or not public.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"panel\": \"\",\n \"name\": \"\",\n \"subpanels\": [\n {\n \"name\": \"\",\n \"panel\": \"\",\n \"arguments\": {}\n },\n {\n \"name\": \"\",\n \"panel\": \"\",\n \"arguments\": {}\n }\n ],\n \"arguments\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/dynamic-pages?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "dynamic-pages" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "notifications", "item": [ { "name": "click", "item": [ { "name": "Click notification on customer eSales action", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ticket\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/click?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "click" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] }, "description": "The click notification is to be sent with a ticket when the visitor clicks on a product, an ad, or any other eSales entities. The ticket is a unique string for an object generated by eSales.\n" }, "response": [ { "name": "Notifications was received successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ticket\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/click?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "click" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Invalid or missing required arguments.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ticket\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/click?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "click" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "non-esales-click", "item": [ { "name": "Click notification on customer non-eSales action", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"productKey\": \"\",\n \"variantKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/non-esales-click?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "non-esales-click" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] }, "description": "The non-eSales click notification is to be sent when a visitor has clicked a product that is not returned by eSales (i.e. not having a ticket). Instead of a ticket, a product key (and if applicable, a variant key) is sent.\n" }, "response": [ { "name": "Notifications was received successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"productKey\": \"\",\n \"variantKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/non-esales-click?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "non-esales-click" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Invalid or missing required arguments.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"productKey\": \"\",\n \"variantKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/non-esales-click?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "non-esales-click" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "adding-to-cart", "item": [ { "name": "Add to cart notification for eSales product", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ticket\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/adding-to-cart?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "adding-to-cart" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] }, "description": "The adding-to-cart notification is to be sent with a ticket when a visitor adds an eSales product to their cart. The ticket is a unique string for an object generated by eSales.\n" }, "response": [ { "name": "Notifications was received successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ticket\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/adding-to-cart?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "adding-to-cart" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Invalid or missing required arguments.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ticket\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/adding-to-cart?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "adding-to-cart" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "non-esales-adding-to-cart", "item": [ { "name": "Add to cart notification for non-eSales product", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"productKey\": \"\",\n \"variantKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/non-esales-adding-to-cart?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "non-esales-adding-to-cart" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] }, "description": "The non-esales adding-to-cart notification is sent when a visitor adds a product not returned by eSales (i.e. not having a ticket) to their cart. Instead of a ticket, a product key (and if applicable, a variant key) is sent.\n" }, "response": [ { "name": "Notifications was received successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"productKey\": \"\",\n \"variantKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/non-esales-adding-to-cart?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "non-esales-adding-to-cart" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Ticket is missing.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"productKey\": \"\",\n \"variantKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/non-esales-adding-to-cart?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "non-esales-adding-to-cart" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "A personal customer key was used, but it could not be validated.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"productKey\": \"\",\n \"variantKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/non-esales-adding-to-cart?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "non-esales-adding-to-cart" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "payment", "item": [ { "name": "Payment notification upon successful transaction", "request": { "method": "POST", "header": [ { "description": "secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"productKey\": \"\",\n \"quantity\": \"\",\n \"sellingPrice\": \"\",\n \"cost\": \"\"\n },\n {\n \"productKey\": \"\",\n \"quantity\": \"\",\n \"sellingPrice\": \"\",\n \"cost\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/payment?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "payment" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] }, "description": "The payment notification is to be sent when the visitor has placed an order of one or more products and completed payment.\n" }, "response": [ { "name": "Notifications was received successfully.", "originalRequest": { "method": "POST", "header": [ { "description": "secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"productKey\": \"\",\n \"quantity\": \"\",\n \"sellingPrice\": \"\",\n \"cost\": \"\"\n },\n {\n \"productKey\": \"\",\n \"quantity\": \"\",\n \"sellingPrice\": \"\",\n \"cost\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/payment?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "payment" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "There were no order lines in the payment notification, missing or invalid required arguments.", "originalRequest": { "method": "POST", "header": [ { "description": "secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"productKey\": \"\",\n \"quantity\": \"\",\n \"sellingPrice\": \"\",\n \"cost\": \"\"\n },\n {\n \"productKey\": \"\",\n \"quantity\": \"\",\n \"sellingPrice\": \"\",\n \"cost\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/payment?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "payment" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Client side payment notifications has been disabled for this cluster.", "originalRequest": { "method": "POST", "header": [ { "description": "secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"productKey\": \"\",\n \"quantity\": \"\",\n \"sellingPrice\": \"\",\n \"cost\": \"\"\n },\n {\n \"productKey\": \"\",\n \"quantity\": \"\",\n \"sellingPrice\": \"\",\n \"cost\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/payment?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "payment" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "favorite", "item": [ { "name": "add", "item": [ { "name": "Add favorite notification for a eSales product", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"productKey\": \"\",\n \"variantKey\": \"\",\n \"remove\": -38287551\n },\n {\n \"productKey\": \"\",\n \"variantKey\": \"\",\n \"remove\": \"reprehenderit non voluptate ut cupidatat\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/favorite/add?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "favorite", "add" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] }, "description": "Add favorite notification is to be used when a customer marks a product as favorite.\n" }, "response": [ { "name": "Notifications was received successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"productKey\": \"\",\n \"variantKey\": \"\",\n \"remove\": -38287551\n },\n {\n \"productKey\": \"\",\n \"variantKey\": \"\",\n \"remove\": \"reprehenderit non voluptate ut cupidatat\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/favorite/add?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "favorite", "add" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Invalid or missing required arguments.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"productKey\": \"\",\n \"variantKey\": \"\",\n \"remove\": -38287551\n },\n {\n \"productKey\": \"\",\n \"variantKey\": \"\",\n \"remove\": \"reprehenderit non voluptate ut cupidatat\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/favorite/add?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "favorite", "add" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "remove", "item": [ { "name": "Remove favorite notification for a eSales product", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"productKey\": \"\",\n \"variantKey\": \"\",\n \"remove\": -38287551\n },\n {\n \"productKey\": \"\",\n \"variantKey\": \"\",\n \"remove\": \"reprehenderit non voluptate ut cupidatat\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/favorite/remove?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "favorite", "remove" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] }, "description": "Remove favorite notification is to be used when a customer unmarks a product as favorite.\n" }, "response": [ { "name": "Notifications was received successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"productKey\": \"\",\n \"variantKey\": \"\",\n \"remove\": -38287551\n },\n {\n \"productKey\": \"\",\n \"variantKey\": \"\",\n \"remove\": \"reprehenderit non voluptate ut cupidatat\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/favorite/remove?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "favorite", "remove" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Invalid or missing required arguments.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"productKey\": \"\",\n \"variantKey\": \"\",\n \"remove\": -38287551\n },\n {\n \"productKey\": \"\",\n \"variantKey\": \"\",\n \"remove\": \"reprehenderit non voluptate ut cupidatat\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/favorite/remove?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "favorite", "remove" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "end", "item": [ { "name": "End current session notification", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/notifications/end?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "end" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] }, "description": "To end a visitor session, an end notification is to be sent to Voyado Elevate. The level of personalisation affects the actions performed when a session ends.\n" }, "response": [ { "name": "Notifications was received successfully.", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/notifications/end?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "end" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Invalid or missing required arguments.", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/notifications/end?esales.customerKey=00000000-0000-0000-0000-000000000000&esales.sessionKey=00000000-0000-0000-0000-000000000000&esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", "end" ], "query": [ { "key": "esales.customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique customer key (UUID)" }, { "key": "esales.sessionKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Unique session key (UUID)" }, { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "import", "item": [ { "name": "{type}", "item": [ { "name": "Import products, configuration. etc", "request": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\n (string)\n\n\n (string)\n", "options": { "raw": { "headerFamily": "xml", "language": "xml" } } }, "url": { "raw": "{{baseUrl}}/api/v2/import/:type?name=&blockingTimeout=PT5M", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "import", ":type" ], "query": [ { "key": "name", "value": "", "description": "Name of import" }, { "key": "blockingTimeout", "value": "PT5M", "description": "Max duration to wait for a response." } ], "variable": [ { "key": "type", "value": "panels,configuration" } ] }, "description": "Imports is the method used to add data into eSales by way of posting XML to the Web API. The XML must be encoded using UTF-8 and include the operations that is to be performed and all other data type related information. Allowed operations for imports are add, update, remove, and clear.\n\nWhen importing data via the Web API, an Api-Key header is required for authentication.\n" }, "response": [ { "name": "The import completed successfully.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\n (string)\n\n\n (string)\n", "options": { "raw": { "headerFamily": "xml", "language": "xml" } } }, "url": { "raw": "{{baseUrl}}/api/v2/import/:type?name=&blockingTimeout=PT5M", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "import", ":type" ], "query": [ { "key": "name", "value": "", "description": "Name of import" }, { "key": "blockingTimeout", "value": "PT5M", "description": "Max duration to wait for a response." } ], "variable": [ { "key": "type" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Incorrect Api-Key.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\n (string)\n\n\n (string)\n", "options": { "raw": { "headerFamily": "xml", "language": "xml" } } }, "url": { "raw": "{{baseUrl}}/api/v2/import/:type?name=&blockingTimeout=PT5M", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "import", ":type" ], "query": [ { "key": "name", "value": "", "description": "Name of import" }, { "key": "blockingTimeout", "value": "PT5M", "description": "Max duration to wait for a response." } ], "variable": [ { "key": "type" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Cluster not found.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\n (string)\n\n\n (string)\n", "options": { "raw": { "headerFamily": "xml", "language": "xml" } } }, "url": { "raw": "{{baseUrl}}/api/v2/import/:type?name=&blockingTimeout=PT5M", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "import", ":type" ], "query": [ { "key": "name", "value": "", "description": "Name of import" }, { "key": "blockingTimeout", "value": "PT5M", "description": "Max duration to wait for a response." } ], "variable": [ { "key": "type" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "export", "item": [ { "name": "{type}", "item": [ { "name": "Export products, configuration. etc", "request": { "method": "GET", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/export/:type?name=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "export", ":type" ], "query": [ { "key": "name", "value": "", "description": "Name of export" } ], "variable": [ { "key": "type", "value": "panels,configuration" } ] }, "description": "Exports is the method used to extract data from eSales. When exporting data via the Web API, an Api-Key header is required for authentication.\n" }, "response": [ { "name": "The export completed successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/export/:type?name=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "export", ":type" ], "query": [ { "key": "name", "value": "", "description": "Name of export" } ], "variable": [ { "key": "type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Incorrect Api-Key.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/export/:type?name=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "export", ":type" ], "query": [ { "key": "name", "value": "", "description": "Name of export" } ], "variable": [ { "key": "type" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Cluster not found.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/export/:type?name=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "export", ":type" ], "query": [ { "key": "name", "value": "", "description": "Name of export" } ], "variable": [ { "key": "type" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "product-selection", "item": [ { "name": "Get filtered list of products", "request": { "method": "GET", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/export/product-selection?filter=&presentationAttributes=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "export", "product-selection" ], "query": [ { "key": "filter", "value": "", "description": "An expression defining the product and variant set. Default is UNIVERSE." }, { "key": "presentationAttributes", "value": "", "description": "A comma-separated list of the attributes from the product data to present. Default presentation attributes are used if omitted." }, { "key": "limit", "value": "", "description": "The maximum number of products to include in the result." } ] }, "description": "Product lists in eSales can return up to 10 000 products. The product selection exports allows for extracting a filtered product\nlist from eSales that includes more than 10 000 products. When exporting data via the Web API, an Api-Key header is required for authentication.\n" }, "response": [ { "name": "The export completed successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/export/product-selection?filter=&presentationAttributes=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "export", "product-selection" ], "query": [ { "key": "filter", "value": "", "description": "An expression defining the product and variant set. Default is UNIVERSE." }, { "key": "presentationAttributes", "value": "", "description": "A comma-separated list of the attributes from the product data to present. Default presentation attributes are used if omitted." }, { "key": "limit", "value": "", "description": "The maximum number of products to include in the result." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Incorrect Api-Key.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/export/product-selection?filter=&presentationAttributes=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "export", "product-selection" ], "query": [ { "key": "filter", "value": "", "description": "An expression defining the product and variant set. Default is UNIVERSE." }, { "key": "presentationAttributes", "value": "", "description": "A comma-separated list of the attributes from the product data to present. Default presentation attributes are used if omitted." }, { "key": "limit", "value": "", "description": "The maximum number of products to include in the result." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Cluster not found.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/export/product-selection?filter=&presentationAttributes=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "export", "product-selection" ], "query": [ { "key": "filter", "value": "", "description": "An expression defining the product and variant set. Default is UNIVERSE." }, { "key": "presentationAttributes", "value": "", "description": "A comma-separated list of the attributes from the product data to present. Default presentation attributes are used if omitted." }, { "key": "limit", "value": "", "description": "The maximum number of products to include in the result." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "event-data", "item": [ { "name": "create-export-customer-job", "item": [ { "name": "Create export of customer information", "request": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/event-data/create-export-customer-job?customerKey=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-data", "create-export-customer-job" ], "query": [ { "key": "customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Customer key (UUID)" } ] }, "description": "Create job to export information regarding a specific customer.\n" }, "response": [ { "name": "Return event data job, including job id and status", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/event-data/create-export-customer-job?customerKey=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-data", "create-export-customer-job" ], "query": [ { "key": "customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Customer key (UUID)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Invalid or missing customer key.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/event-data/create-export-customer-job?customerKey=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-data", "create-export-customer-job" ], "query": [ { "key": "customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Customer key (UUID)" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "create-remove-customer-job", "item": [ { "name": "Remove customer information", "request": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/event-data/create-remove-customer-job?customerKey=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-data", "create-remove-customer-job" ], "query": [ { "key": "customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Customer key (UUID)" } ] }, "description": "Create a job to remove customer information.\n" }, "response": [ { "name": "Return event data job, including job id and status", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/event-data/create-remove-customer-job?customerKey=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-data", "create-remove-customer-job" ], "query": [ { "key": "customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Customer key (UUID)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Invalid or missing customer key.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/event-data/create-remove-customer-job?customerKey=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-data", "create-remove-customer-job" ], "query": [ { "key": "customerKey", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Customer key (UUID)" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "job-status", "item": [ { "name": "Check job status", "request": { "method": "GET", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/event-data/job-status?jid=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-data", "job-status" ], "query": [ { "key": "jid", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Job ID (UUID)" } ] }, "description": "Checks the status of a create job.\n" }, "response": [ { "name": "Return job status", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/event-data/job-status?jid=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-data", "job-status" ], "query": [ { "key": "jid", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Job ID (UUID)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Invalid or missing jid.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/event-data/job-status?jid=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-data", "job-status" ], "query": [ { "key": "jid", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Job ID (UUID)" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "export-customer-job-result", "item": [ { "name": "Export customer information", "request": { "method": "GET", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/event-data/export-customer-job-result?jid=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-data", "export-customer-job-result" ], "query": [ { "key": "jid", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Job ID (UUID)" } ] }, "description": "Gets the result of a job, if done, based on jid. \n" }, "response": [ { "name": "Return job status", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/event-data/export-customer-job-result?jid=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-data", "export-customer-job-result" ], "query": [ { "key": "jid", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Job ID (UUID)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Invalid or missing jid.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v2/event-data/export-customer-job-result?jid=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-data", "export-customer-job-result" ], "query": [ { "key": "jid", "value": "00000000-0000-0000-0000-000000000000", "description": "(Required) Job ID (UUID)" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "migrations", "item": [ { "name": "customer-keys", "item": [ { "name": "Customer key migration", "request": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"oldKey\": \"\",\n \"newKey\": \"\"\n },\n {\n \"oldKey\": \"\",\n \"newKey\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/migrations/customer-keys?esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "migrations", "customer-keys" ], "query": [ { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] }, "description": "Migrate old customer keys to UUID v4 format, and keep behaviour data \n" }, "response": [ { "name": "Migration successful", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"oldKey\": \"\",\n \"newKey\": \"\"\n },\n {\n \"oldKey\": \"\",\n \"newKey\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/migrations/customer-keys?esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "migrations", "customer-keys" ], "query": [ { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Invalid body", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) secret api key", "key": "Api-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"oldKey\": \"\",\n \"newKey\": \"\"\n },\n {\n \"oldKey\": \"\",\n \"newKey\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/migrations/customer-keys?esales.market=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "migrations", "customer-keys" ], "query": [ { "key": "esales.market", "value": "", "description": "(Required) Customer market" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "clusterId", "value": "w00000000" }, { "key": "baseUrl", "value": "https://{{clusterId}}.elevate-api.cloud" } ] }