{"openapi": "3.0.0", "info": {"description": "The Mergado API is based on REST principles. The request/response format is JSON. This documentation is a part of [Mergado Docs](https://mergado.github.io/docs/intro/the-basics.html).\n\n## 📋 Changelog\n
Show changelog history
\n\n\n ### 2026-03-19\n\n#### Added\n\n* Endpoint `/shops/{id}/google/merchant/proxy/{path}`\n\n ### 2025-12-03\n\n#### Changed\n\n* Endpoint GET `/shops/{id}/info`\n - Removed obsolete connections.\n - Removed vague fields: `currency`, `status`, `valid_credentials` and `error` from connections.\n\n#### Added\n\n* Endpoint `/shops/{id}/{connection}/validate`\n\n### 2025-09-24\n\n#### Added\n\n* Endpoint `/shops/{id}/unas/proxy/{path}`\n\n### 2025-09-24\n\n#### Changed\n\n* Endpoint `POST /shops/{id}/notifications/`\n - Field `scope` now receives and returns `'eshop'|'owner'` instead of `'shop'|'owner'`.\n - Returned JSON contains new fields: `event`, `data`.\n - Success response no longer contains `Location` header.\n\n* Endpoint `GET /notifications/{id}/`\n - Now requires scope `user.notify.read`.\n - **Stricter access control**\n - Returned JSON contains new fields: `event`, `data`.\n\n* Endpoint `GET /users/{user_identifier}/notifications/`\n - Structure for each notification in response's `data` list is now the same as what `GET /notifications/{id}/` returns.\n\n* Endpoint `POST /users/{user_identifier}/notifications/`\n - Success response no longer contains `Location` header.\n\n### 2025-09-24\n\n#### Added\n\n* Endpoint `/shops/{id}/eshop-rychle/proxy/{path}`\n\n### 2025-08-22\n\n#### Added\n\n* Endpoint `/shops/{id}/heureka/proxy/{path}`\n\n* Field `api_enabled` to `/shops//info`\n\n### 2025-03-23\n\n#### Added\n\n* `element_path` and `is_output` parameter for `/projects/{id}/elements/values` and `/projects/{id}/elements/values` endpoints\n\n### 2025-02-13\n\n#### Added\n\n* `is_hidden` parameter for `projects/{id}/products/` and `/queries/{id}/products/` endpoints\n\n### 2025-01-09\n\n#### Changed\n\n* Renamed the fields `xml_changed_at` and `xml_synced_at` to `data_changed_at` and `data_synced_at` in the `projects/id/` endpoint\n\n### 2024-09-11\n\n#### Added\n\n* `invoicing_validity_date`, `avatars`, and `phone` fields to the `/users/` and `/users/{id}/` endpoints, these endpoints are now also accessible with offline tokens\n\n* **POST** method for `/products/{id}/` endpoint to set the `is_dirty` field\n\n### 2024-07-24\n\n#### Added\n\n* `in_testing_mode` field in `/shops/{id}/projects/` and `/projects/{id}/` endpoints\n\n#### Removed\n\n* `created_at` field in `/projects/{id}/products/`, `/products/{id}/` and `/queries/{id}/products/` endpoints\n\n### 2024-01-25\n\n#### Added\n\n* `values_to_extract` parameter for `/queries/{id}/products/` endpoint\n\n### 2023-10-10\n\n#### Added\n\n* `values_to_extract` parameter for `projects/{id}/products/` endpoint\n\n### 2022-09-14\n\n#### Added\n\n* Endpoint `/formats/{format_id}`\n\n* Endpoint `/formats/{format_id}/specification`\n\n#### Changed\n\n* Versioning\n\n* Endpoint `/projects/{id}/elements`\n\n* Endpoint `/elements/{id}`\n\n* Endpoint `/projects/{id}/products`\n\n* Endpoint `/products/{id}`\n\n* Endpoint `/queries/{id}/products`\n
\n\n\n## Requests\n\nThe recommended encoding of all requests is UTF-8. Requests must be made over **HTTPS** and\nall endpoints start with `https://api.mergado.com/`. Note that almost all API endpoints\nrequire [OAuth 2.0 authentication](https://tools.ietf.org/html/rfc6749).\n\n### Allowed HTTPs requests\n\n| Method | Description |\n|--------|----------------------------------------------|\n| GET | Retrieves a resource or a list of resources. |\n| POST | Creates or updates a resource. |\n| PATCH | Updates a resource. |\n| DELETE | Deletes a resource. |\n\n### Additional GET parameters\n\n| Parameter | Example | Description |\n|------------------------------|--------------------------------------------------------------------------|-------------|\n| **fields** | `?fields=uri,shop.id` | Only fields `uri` and `id` nested in `shop` will be returned in the given example. It works also for arrays of results - filter is applied to all their items, one by one. |\n| **limit**, **offset** | `?limit=5&offset=2` | Works for arrays only. It is for paging the results. In the example, 2 results from the beginning are skipped and only 5 following items are returned. The default limit for every array result is 10 items. |\n| **date** | `?date=2015-12-24` | Works only for some special endpoints. In the example, it will return results corresponding only to Christmas Eve in 2015.\n| **filter** | `?filter=[{\"field\": \"to\", \"op\": \">=\", \"value\": \"2021-08-08T13:00:00\"}]` | Filters the result. Parameter accepts a valid JSON list with at least one filter. Returned objects meet conditions for all filters. Supported operators are: `=`, `!=`, `<=`, `>=`, `<`, `>`, `~` (regexp), `in`. Only numbers and timestamps in ISO 8601 format can be ordinally compared. Missing values in timestamps will be supplemented by the lowest possible values, eg `\"2015-12-24\"` equals `\"2015-12-24T00:00:00+00:00\"`. Checks for `null` values is possible with `=` and `!=`. For other operators the comparison with `null` will always fail. Only non-nested fields are expected. |\n| **order_by** | `?order_by=validator,-verdict` | Orders the result in ascending or descending order. |\n| filter_by | `?filter_by={\"item_id__in\":[\"123456789\"]}` | **!! DEPRECATED !!** Used only for Feed Audit and Statistics. Filters the result. You can also append field name with `__in`, i.e. filter results by enumerating all values of a field, for example `item_id__in` expects list of possible ITEM_IDs. |\n| **values_to_extract** | `?values_to_extract=[\"ITEM_ID\", \"PARAM | PARAM_NAME\", \"Variable\"]` | The functionality is limited to the `List Products` endpoint. You can specify a list of element paths or variable names for which the endpoint will return a list of values in a new field called `extracted_values`. |\n| **mql** | `?mql=PRICE_VAT < 100` | The functionality is limited to the `List Products` endpoints. Parameter allows filtering products based on [MQL](https://mergado.github.io/docs/apps/rules-and-queries.html) query. |\n| **is_hidden** | `?is_hidden=false` | The functionality is limited to the `List Products` endpoints. Parameter allows filtering products based on their visibility status. |\n| **element_path** | `?element_path=GIFT { NO_ATTR = \"sleva 20%\" } | @ID` | The functionality is limited to the `Element values` endpoints. Parameter allows filtering element values based on their `element path.`|\n| **is_output** | `?is_output=true` | The function is limited to `Element Values` endpoints. The parameter allows you to specify whether to return the input or output values ​​of the element.`|\n\n#### Encoding\n\nAll special characters in additional GET parameter values must be URL-encoded (also known as percent-encoding).\n\n### Typical Server Responses\n\n| Code | Status | Description |\n|------|--------------------|-------------|\n| 200 | OK | The request was successful (some API calls may return 201 instead). In case of arrays, `total_results` or `after` is returned as part of the envelope (together with `limit` and `offset`). It corresponds to the total amount of resources that match the request. |\n| 201 | Created | The request was successful and a resource was created. |\n| 204 | No Content | The request was successful but there is no representation to return (that is, the response is empty). |\n| 400 | Bad Request | The request could not be understood or was missing required parameters. |\n| 401 | Unauthorized | Authentication failed or user does not have permissions for the requested operation. |\n| 403 | Forbidden | Access denied. |\n| 404 | Not Found | Resource was not found. |\n| 405 | Method Not Allowed | Requested method is not supported for the specified resource. |\n| 409 | Conflict | Resource already exists and could not be created. |\n\n## OAuth 2.0\n\nTo access Mergado API, clients (e.g. an application) are required to authenticate with\n[OAuth 2.0](https://tools.ietf.org/html/rfc6749). Each application is required to have\nits OAuth credentials which can be obtained from the Mergado\n[developers center](https://developers.mergado.com) (during registeration of your application,\na client ID and a secret key is assigned to your application).\n\n* [Basics of OAuth 2.0 in Mergado Apps](http://mergado.github.io/docs/api/authorization.html)\n\n* [List of all OAuth scopes](http://mergado.github.io/docs/api/oauth-scopes.html)\n\n### Online and offline access tokens\n\nMergado API distinguishes between situations where your Mergado platform app accesses API **on behalf of some specific Mergado user** and where the app is accessing API **on behalf of the app itself**.\n\nAccess tokens bound to some specific user ID are called ***online*** tokens. Access tokens bound only to the app itself are called ***offline*** tokens.\n\n## Versioning\n\nVersioning is implemented using the `use-mergado-api-version` header. The valid syntax is:\n`use-mergado-api-version`: \"YYYY-MM-DD\", eg. `use-mergado-api-version`: \"2022-01-19\".\n\nFor any endpoint,\n\n* in case of a date X is specified in the `use-mergado-api-version` header, and\n * there exists only one endpoint version, then the default endpoint version will be used,\n * there exist endpoint versions valid until dates A and B, and the newest version C, and A < B < X < C holds, then the newest version of the endpoint C will be used,\n * there exist only endpoint versions valid until the dates A and B, and A < B < X holds (i.e. there is no newest version), then the error 404 will be returned,\n\n* in case of there is no date specified in the `use-mergado-api-version` header, the endpoint valid on 2020-09-07 will be used.\n\nNote that all request and response examples match the latest version.", "title": "Mergado", "version": ""}, "servers": [{"url": "https://api.mergado.com/"}], "paths": {"/": {"get": {"responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"version_for": "2022-01-19"}}}, "schema": {"example": {"version_for": "2022-01-19"}, "properties": {"version_for": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Base"], "description": "Returns date for a current default API implementation that is used when `use-mergado-api-version` header is not provided (see Versioning for more).\n\n**GET** `https://api.mergado.com/`", "summary": "Show API Version"}}, "/access/check": {"post": {"requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AccessCheckRequest"}, "examples": {"response": {"value": {"checks": [{"entity_type": "shop", "entity_id": 42, "access": "write"}, {"entity_type": "project", "entity_id": 123, "access": "read"}]}}}}}}, "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/AccessCheckResponse"}, "examples": {"response": {"value": {"results": [{"entity_type": "shop", "entity_id": 42, "access": "write", "allowed": true}, {"entity_type": "project", "entity_id": 123, "access": "read", "allowed": true}]}}}}}, "description": "OK"}, "401": {"description": "Unauthorized"}}, "tags": ["Access"], "description": "Verifies whether the caller (identified by the provided token) has read or write access to one or more target entities.\n\nWhen the token is a JWT with an `aud` field (issued by the app proxy), a **dual access check** is enforced: both the caller and the target app must have independent access to the requested entity.\n\nEach check in the request specifies an `entity_type` (`shop` or `project`), an `entity_id`, and an optional `access` level (`read` or `write`). If `access` is omitted, the endpoint determines the maximum access level.\n\nFor more details, see the [Cross-Platform Communication documentation](https://mergado.github.io/docs/apps/cross-platform-communication.html).\n\n**POST** `https://api.mergado.com/access/check`", "summary": "Check Access"}}, "/accesslogs/{id}/": {"get": {"parameters": [{"description": "ID of a log.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"https": false, "id": "101", "identity": "-", "ip": "111.222.333.444", "referer": "-", "request": "GET /mergadovenaradie-cz-heureka-cz-greagfsdabtrshthgreav.xml HTTP/1.1", "size": 627142, "status": 200, "time": "2016-05-15T08:18:13+00:00", "user": "-", "user_agent": "Heurekabot-Feed/1.0 (+http://sluzby.heureka.cz/napoveda/heurekabot/)"}}}, "schema": {"example": {"https": false, "id": "101", "identity": "-", "ip": "111.222.333.444", "referer": "-", "request": "GET /mergadovenaradie-cz-heureka-cz-greagfsdabtrshthgreav.xml HTTP/1.1", "size": 627142, "status": 200, "time": "2016-05-15T08:18:13+00:00", "user": "-", "user_agent": "Heurekabot-Feed/1.0 (+http://sluzby.heureka.cz/napoveda/heurekabot/)"}, "properties": {"https": {"type": "boolean"}, "id": {"type": "string"}, "identity": {"type": "string"}, "ip": {"type": "string"}, "referer": {"type": "string"}, "request": {"type": "string"}, "size": {"type": "number"}, "status": {"type": "number"}, "time": {"type": "string"}, "user": {"type": "string"}, "user_agent": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}, "410": {"content": {"application/json": {"examples": {"response": {"value": {"message": "The associated project for this log has been deleted"}}}, "schema": {"example": {"message": "The associated project for this log has been deleted"}, "properties": {"message": {"type": "string"}}, "type": "object"}}}, "description": "Gone", "headers": {}}}, "tags": ["Logs"], "description": "Fetches an access log with the given ID. If the related project has been deleted, 410 is returned instead.\n\n**OAuth2 Scope:** `project.logs.read`.\n\n**GET** `https://api.mergado.com/accesslogs/id/`", "summary": "Get an Access Log"}}, "/applylogs/{id}/": {"get": {"parameters": [{"description": "ID of a log.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"applied_to_all_items": true, "duration": 1.548, "finished_at": "2016-05-18T15:16:26+00:00", "id": "155", "items": 1, "rules": [{"processed_products": 64, "products": 64, "rule_id": "1"}], "started_at": "2016-05-18T15:16:25+00:00", "user_id": "1"}}}, "schema": {"example": {"applied_to_all_items": true, "duration": 1.548, "finished_at": "2016-05-18T15:16:26+00:00", "id": "155", "items": 1, "rules": [{"processed_products": 64, "products": 64, "rule_id": "1"}], "started_at": "2016-05-18T15:16:25+00:00", "user_id": "1"}, "properties": {"applied_to_all_items": {"type": "boolean"}, "duration": {"type": "number"}, "finished_at": {"type": "string"}, "id": {"type": "string"}, "items": {"type": "number"}, "rules": {"items": {"properties": {"processed_products": {"type": "number"}, "products": {"type": "number"}, "rule_id": {"type": "string"}}, "type": "object"}, "type": "array"}, "started_at": {"type": "string"}, "user_id": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Logs"], "description": "Fetches an apply log with the given ID.\n**OAuth2 Scope:** `project.logs.read`.\n**GET** `https://api.mergado.com/applylogs/id/`\n\n**Attributes:**\n* **id (string):** ID of the log.\n* **duration (number):** How long the action took.\n* **started_at (string):** When the action started.\n* **finished_at (string):** When the action ended.\n* **rules (array):** List of rules involved in the action.\n* **user_id (string):** ID of the user who started the action.\n* **applied_to_all_items (boolean):** Whether the action has been performed on all products.", "summary": "Get an Apply Log"}}, "/apps/": {"get": {"summary": "List Apps", "tags": ["Apps"], "description": "Lists all applications in Mergado.\n\n **GET** `https://api.mergado.com/apps/`", "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"type": "object", "properties": {"data": {"type": "array", "items": {"$ref": "#/components/schemas/Apps"}}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}}, "examples": {"response": {"value": {"data": [{"creation_date": "2016-11-02T09:12:09+00:00", "forum_url": "bidding-fox", "latest_release_date": "2016-11-02T09:12:10+00:00", "title": "Bidding Fox", "trial_period": 10, "type": "project"}], "limit": 10, "offset": 0, "total_results": 1}}}}}, "headers": {}}}}}, "/apps/{id}/": {"get": {"parameters": [{"description": "Application name.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"creation_date": "2016-11-02T09:12:09+00:00", "forum_url": "logbook", "latest_release_date": "2016-11-02T09:12:10+00:00", "title": "Log Book Application", "trial_period": 10, "type": "project"}}}, "schema": {"example": {"creation_date": "2016-11-02T09:12:09+00:00", "forum_url": "logbook", "latest_release_date": "2016-11-02T09:12:10+00:00", "title": "Log Book Application", "trial_period": 10, "type": "project"}, "properties": {"creation_date": {"type": "string"}, "forum_url": {"type": "string"}, "latest_release_date": {"type": "string"}, "title": {"type": "string"}, "trial_period": {"type": "number"}, "type": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Apps"], "description": "Returns application for given application name. **GET** `https://api.mergado.com/apps/id/`", "summary": "Get App by Name"}}, "/apps/{app_full_name}/proxy/{path}": {"get": {"parameters": [{"description": "Full name of the target app (e.g. `myapp` or `myapp.dev`).", "in": "path", "name": "app_full_name", "required": true, "schema": {"type": "string"}}, {"description": "Path to forward to the target app's API.", "in": "path", "name": "path", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "Proxied response from the target app."}, "401": {"description": "Unauthorized — missing or invalid token."}, "404": {"description": "App not found or app has no API URL configured."}}, "tags": ["App Proxy"], "description": "Transparent proxy to a registered app's API. Any HTTP request sent to this endpoint is intercepted by Mergado, which:\n\n1. Verifies that the caller holds a valid Mergado API token.\n2. Computes the scope intersection between the caller's scopes and the target app's registered scopes.\n3. Generates a short-lived JWT token containing the caller's identity, intersected scopes, and the target app as `aud` (audience).\n4. Forwards the request to the target app's configured `api_url` with the JWT in the `Authorization` header.\n\nThe JWT token contains the following fields:\n- `entity_id` — ID of the entity making the request.\n- `entity_type` — Type of the entity: `user`, `shop`, or `project`.\n- `scopes` — Intersection of the caller's OAuth scopes and the target app's scopes.\n- `aud` — Full name of the target app (audience).\n- `exp` — Expiration timestamp (~5 minutes).\n\nAll HTTP methods (GET, POST, PUT, PATCH, DELETE) are supported. Query parameters, headers, and request body are forwarded unchanged.\n\nFor more details, see the [Cross-Platform Communication documentation](https://mergado.github.io/docs/apps/cross-platform-communication.html).\n\n**GET** `https://api.mergado.com/apps/{app_full_name}/proxy/{path}`", "summary": "Proxy Request to App"}, "post": {"parameters": [{"description": "Full name of the target app.", "in": "path", "name": "app_full_name", "required": true, "schema": {"type": "string"}}, {"description": "Path to forward to the target app's API.", "in": "path", "name": "path", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "Proxied response from the target app."}, "401": {"description": "Unauthorized."}, "404": {"description": "App not found or no API URL configured."}}, "tags": ["App Proxy"], "description": "Forwards a POST request to the target app's API with JWT authorization.", "summary": "Proxy POST Request to App"}, "put": {"parameters": [{"description": "Full name of the target app.", "in": "path", "name": "app_full_name", "required": true, "schema": {"type": "string"}}, {"description": "Path to forward to the target app's API.", "in": "path", "name": "path", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "Proxied response from the target app."}, "401": {"description": "Unauthorized."}, "404": {"description": "App not found or no API URL configured."}}, "tags": ["App Proxy"], "description": "Forwards a PUT request to the target app's API with JWT authorization.", "summary": "Proxy PUT Request to App"}, "patch": {"parameters": [{"description": "Full name of the target app.", "in": "path", "name": "app_full_name", "required": true, "schema": {"type": "string"}}, {"description": "Path to forward to the target app's API.", "in": "path", "name": "path", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "Proxied response from the target app."}, "401": {"description": "Unauthorized."}, "404": {"description": "App not found or no API URL configured."}}, "tags": ["App Proxy"], "description": "Forwards a PATCH request to the target app's API with JWT authorization.", "summary": "Proxy PATCH Request to App"}, "delete": {"parameters": [{"description": "Full name of the target app.", "in": "path", "name": "app_full_name", "required": true, "schema": {"type": "string"}}, {"description": "Path to forward to the target app's API.", "in": "path", "name": "path", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "Proxied response from the target app."}, "401": {"description": "Unauthorized."}, "404": {"description": "App not found or no API URL configured."}}, "tags": ["App Proxy"], "description": "Forwards a DELETE request to the target app's API with JWT authorization.", "summary": "Proxy DELETE Request to App"}}, "/elements/{id}/": {"delete": {"parameters": [{"description": "ID of an element.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content", "headers": {}}}, "tags": ["Elements"], "description": "Delete the specified element and all of its children.\n\n**OAuth2 Scope:** `project.elements.write`\n\n**DELETE** `https://api.mergado.com/elements/id/`", "summary": "Delete an Element"}, "get": {"parameters": [{"description": "ID of an element.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"hidden": false, "is_attribute": false, "name": "SHIPPING", "order": 3, "origin": "manual", "parent_id": null}}}, "schema": {"example": {"hidden": false, "is_attribute": false, "name": "SHIPPING", "order": 3, "origin": "manual", "parent_id": null}, "properties": {"hidden": {"type": "boolean"}, "is_attribute": {"type": "boolean"}, "name": {"type": "string"}, "order": {"type": "number"}, "origin": {"type": "string"}, "parent_id": {"nullable": true}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Elements"], "description": "Returns an element.\n\n**OAuth2 Scope:** `project.elements.read`\n\n**GET** `https://api.mergado.com/elements/id/`", "summary": "Get an Element"}}, "/eshop/{id}/eventlogs/": {"get": {"parameters": [{"description": "ID of a e-shop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"created_at": "2020-09-18T08:20:14+00:00", "event": "deleted", "id": "1", "source": "project", "subject_id": "1", "subject_name": "Heureka.cz", "user_id": "1", "user_name": "Jon Doe"}, {"created_at": "2020-09-18T09:09:01+00:00", "event": "invitation", "id": "2", "source": "eshop", "subject_id": "3", "subject_name": "test@example.com - reader", "user_id": "1", "user_name": "Jon Doe"}, {"created_at": "2020-09-18T12:58:08+00:00", "event": "created", "id": "3", "source": "keychain", "subject_id": null, "subject_name": "googleanalytics", "user_id": "2", "user_name": "Rája Test"}, {"created_at": "2020-09-18T13:02:37+00:00", "event": "deleted", "id": "4", "source": "keychain", "subject_id": null, "subject_name": "google_analytics", "user_id": "1", "user_name": "Jon Doe"}], "limit": 10, "offset": 0, "total_results": 4}}}, "schema": {"example": {"data": [{"created_at": "2020-09-18T08:20:14+00:00", "event": "deleted", "id": "1", "source": "project", "subject_id": "1", "subject_name": "Heureka.cz", "user_id": "1", "user_name": "Jon Doe"}, {"created_at": "2020-09-18T09:09:01+00:00", "event": "invitation", "id": "2", "source": "eshop", "subject_id": "3", "subject_name": "test@example.com - reader", "user_id": "1", "user_name": "Jon Doe"}, {"created_at": "2020-09-18T12:58:08+00:00", "event": "created", "id": "3", "source": "keychain", "subject_id": null, "subject_name": "googleanalytics", "user_id": "2", "user_name": "Rája Test"}, {"created_at": "2020-09-18T13:02:37+00:00", "event": "deleted", "id": "4", "source": "keychain", "subject_id": null, "subject_name": "google_analytics", "user_id": "1", "user_name": "Jon Doe"}], "limit": 10, "offset": 0, "total_results": 4}, "properties": {"data": {"items": {"properties": {"created_at": {"type": "string"}, "event": {"type": "string"}, "id": {"type": "string"}, "source": {"type": "string"}, "subject_id": {"nullable": true, "type": "string"}, "subject_name": {"type": "string"}, "user_id": {"type": "string"}, "user_name": {"type": "string"}}, "required": ["id", "created_at", "user_id", "user_name", "source", "event", "subject_id", "subject_name"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Logs"], "description": "Fetches all e-shop events logs.\nPossible sources:\n - **project**\n Possible events:\n - `created` - Project created\n - `deleted` - Project deleted\n - `enabled` - Project enabled\n - `disabled` - Project disabled\n - **eshop**\n Possible events:\n - `invitation` - Invitation send\n - **keychain** - Events of keychain app\n Possible events:\n - `created` - Connection to provider created\n - `deleted` - Connection to provider deleted\n\n**OAuth2 Scope:** `eshop.read`\n\n**GET** `https://api.mergado.com/eshop/id/eventlogs/`", "summary": "Get E-shop Event Logs"}}, "/exportlogs/{id}/": {"get": {"parameters": [{"description": "ID of a log.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"duration": 5, "finished_at": null, "id": "1", "initial": false, "items": 20, "processed_items": 20, "started_at": "2016-06-01T15:52:45+00:00", "user_id": "1"}}}, "schema": {"example": {"duration": 5, "finished_at": null, "id": "1", "initial": false, "items": 20, "processed_items": 20, "started_at": "2016-06-01T15:52:45+00:00", "user_id": "1"}, "properties": {"duration": {"type": "number"}, "finished_at": {"nullable": true}, "id": {"type": "string"}, "initial": {"type": "boolean"}, "items": {"type": "number"}, "processed_items": {"type": "number"}, "started_at": {"type": "string"}, "user_id": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Logs"], "description": "Fetches an export log with the given ID.\n\n**OAuth2 Scope:** `project.logs.read`\n\n**GET** `https://api.mergado.com/exportlogs/id/`", "summary": "Get an Export Log"}}, "/feedaudit/audits/{id}/products/": {"get": {"parameters": [{"description": "ID of the audit.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"audit_id": "51768ba7ed14f444772d6137", "elements": [{"elements": [], "tag": "PRODUCT", "value": "Hovězí plíce 100 g"}, {"elements": [], "tag": "DESCRIPTION", "value": "

Čistě dietní krm..."}, {"elements": [], "tag": "DELIVERY_DATE", "value": 1}, {"elements": [], "tag": "PRICE_VAT", "value": 240.5}], "id": "51768ba7ed14f444772d6120"}], "limit": 10, "offset": 0, "total_results": 1}}}, "schema": {"example": {"data": [{"audit_id": "51768ba7ed14f444772d6137", "elements": [{"elements": [], "tag": "PRODUCT", "value": "Hovězí plíce 100 g"}, {"elements": [], "tag": "DESCRIPTION", "value": "

Čistě dietní krm..."}, {"elements": [], "tag": "DELIVERY_DATE", "value": 1}, {"elements": [], "tag": "PRICE_VAT", "value": 240.5}], "id": "51768ba7ed14f444772d6120"}], "limit": 10, "offset": 0, "total_results": 1}, "properties": {"data": {"items": {"properties": {"audit_id": {"type": "string"}, "elements": {"items": {"properties": {"elements": {"items": {}, "type": "array"}, "tag": {"type": "string"}, "value": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "required": ["tag", "value", "elements"], "type": "object"}, "type": "array"}, "id": {"type": "string"}}, "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Feed Audits"], "description": "Returns all products of a specific audit.\n\n**OAuth2 Scope:** `projects.feedaudit.read`\n\n**GET** `https://api.mergado.com/feedaudit/audits/id/products/`", "summary": "List Audit Products"}}, "/feedaudit/products/{id}": {"get": {"parameters": [{"description": "ID of the product.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"audit_id": "51768ba7ed14f444772d6137", "elements": [{"elements": [], "tag": "PRODUCT", "value": "Hovězí plíce 100 g"}, {"elements": [], "tag": "DESCRIPTION", "value": "

Čistě dietní krm..."}, {"elements": [], "tag": "DELIVERY_DATE", "value": 1}, {"elements": [], "tag": "PRICE_VAT", "value": 240.5}], "id": "51768ba7ed14f444772d6120"}}}, "schema": {"example": {"audit_id": "51768ba7ed14f444772d6137", "elements": [{"elements": [], "tag": "PRODUCT", "value": "Hovězí plíce 100 g"}, {"elements": [], "tag": "DESCRIPTION", "value": "

Čistě dietní krm..."}, {"elements": [], "tag": "DELIVERY_DATE", "value": 1}, {"elements": [], "tag": "PRICE_VAT", "value": 240.5}], "id": "51768ba7ed14f444772d6120"}, "properties": {"audit_id": {"type": "string"}, "elements": {"items": {"properties": {"elements": {"items": {}, "type": "array"}, "tag": {"type": "string"}, "value": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "required": ["tag", "value", "elements"], "type": "object"}, "type": "array"}, "id": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Feed Audits"], "description": "Returns a single product resource.\n\n**OAuth2 Scope:** `projects.feedaudit.read`\n\n**GET** `https://api.mergado.com/feedaudit/products/id`", "summary": "Get a Product"}}, "/feedaudit/products/{id}/issues/": {"get": {"parameters": [{"description": "ID of the product.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"info": {"element": "PRODUCT"}, "audit_id": "51768ba7ed14f444772d6137", "checked_at": "2013-04-23T13:24:55+00:00", "feed_types": ["heureka", "zbozi"], "id": "51768ba7ed14f444772d6138", "product_id": "51768ba7ed14f444772d6120", "validator": "is_present_product", "verdict": "error"}], "limit": 10, "offset": 0, "total_results": 1}}}, "schema": {"example": {"data": [{"info": {"element": "PRODUCT"}, "audit_id": "51768ba7ed14f444772d6137", "checked_at": "2013-04-23T13:24:55+00:00", "feed_types": ["heureka", "zbozi"], "id": "51768ba7ed14f444772d6138", "product_id": "51768ba7ed14f444772d6120", "validator": "is_present_product", "verdict": "error"}], "limit": 10, "offset": 0, "total_results": 1}, "properties": {"data": {"items": {"properties": {"info": {"properties": {"element": {"type": "string"}}, "type": "object"}, "audit_id": {"type": "string"}, "checked_at": {"type": "string"}, "feed_types": {"items": {"type": "string"}, "type": "array"}, "id": {"type": "string"}, "product_id": {"type": "string"}, "validator": {"type": "string"}, "verdict": {"type": "string"}}, "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Feed Audits"], "description": "Returns all issues (problematic validations) of a specific product.\n\n**OAuth2 Scope:** `projects.feedaudit.read`\n\n**GET** `https://api.mergado.com/feedaudit/products/id/issues/`", "summary": "List Product's Issues"}}, "/feedaudits/issues/{id}/": {"get": {"parameters": [{"description": "ID of the issue.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"info": {"element": "PRODUCT"}, "audit_id": "51768ba7ed14f444772d6137", "checked_at": "2013-04-23T13:24:55+00:00", "feed_types": ["heureka", "zbozi"], "id": "51768ba7ed14f444772d6138", "level": "recommendation", "product_id": "51768ba7ed14f444772d6120", "validator": "is_present_product", "verdict": "error"}}}, "schema": {"example": {"info": {"element": "PRODUCT"}, "audit_id": "51768ba7ed14f444772d6137", "checked_at": "2013-04-23T13:24:55+00:00", "feed_types": ["heureka", "zbozi"], "id": "51768ba7ed14f444772d6138", "level": "recommendation", "product_id": "51768ba7ed14f444772d6120", "validator": "is_present_product", "verdict": "error"}, "properties": {"info": {"properties": {"element": {"type": "string"}}, "type": "object"}, "audit_id": {"type": "string"}, "checked_at": {"type": "string"}, "feed_types": {"items": {"type": "string"}, "type": "array"}, "id": {"type": "string"}, "level": {"type": "string"}, "product_id": {"type": "string"}, "validator": {"type": "string"}, "verdict": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Feed Audits"], "description": "Returns single issue with given `id`.\n\n**OAuth2 Scope:** `projects.feedaudit.read`\n\n\n**GET** `https://api.mergado.com/feedaudits/issues/id/`", "summary": "Get an Issue"}}, "/feedaudits/{id}/": {"get": {"parameters": [{"description": "ID of the audit.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"encoding": "utf-8", "error": null, "feed_types": ["heureka.cz", "zbozi.cz"], "feed_url": "https://www.example.com/feed.xml", "finished_at": null, "id": "51768ba7ed14f444772d6137", "parser_type": "heureka.cz", "product_count": 8367, "progress": 40, "shop_name": "Example.com", "started_at": "2013-04-23T13:24:55+00:00", "status": "in_progress", "time": 254, "webhook_url": "http://www.example.com/ping.php"}}}, "schema": {"example": {"encoding": "utf-8", "error": null, "feed_types": ["heureka.cz", "zbozi.cz"], "feed_url": "https://www.example.com/feed.xml", "finished_at": null, "id": "51768ba7ed14f444772d6137", "parser_type": "heureka.cz", "product_count": 8367, "progress": 40, "shop_name": "Example.com", "started_at": "2013-04-23T13:24:55+00:00", "status": "in_progress", "time": 254, "webhook_url": "http://www.example.com/ping.php"}, "properties": {"encoding": {"type": "string"}, "error": {"nullable": true}, "feed_types": {"items": {"type": "string"}, "type": "array"}, "feed_url": {"type": "string"}, "finished_at": {"nullable": true}, "id": {"type": "string"}, "parser_type": {"type": "string"}, "product_count": {"type": "number"}, "progress": {"type": "number"}, "shop_name": {"type": "string"}, "started_at": {"type": "string"}, "status": {"type": "string"}, "time": {"type": "number"}, "webhook_url": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Feed Audits"], "description": "Returns the requested audit resource.\n\n**OAuth2 Scope:** `projects.feedaudit.read`\n\n**GET** `https://api.mergado.com/feedaudits/{id}/{?fields`", "summary": "Get an Audit"}}, "/feedaudits/{id}/issues/": {"get": {"parameters": [{"description": "ID of the audit.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"info": {"element": "PRODUCT"}, "audit_id": "51768ba7ed14f444772d6137", "checked_at": "2013-04-23 13:24:55+0000", "feed_types": ["heureka.cz", "zbozi.cz"], "id": "51768ba7ed14f444772d6138", "level": "recommendation", "product_id": "57330212ba49891750549828", "validator": "is_present_product", "verdict": "error"}], "limit": 10, "offset": 0, "total_results": 1}}}, "schema": {"example": {"data": [{"info": {"element": "PRODUCT"}, "audit_id": "51768ba7ed14f444772d6137", "checked_at": "2013-04-23 13:24:55+0000", "feed_types": ["heureka.cz", "zbozi.cz"], "id": "51768ba7ed14f444772d6138", "level": "recommendation", "product_id": "57330212ba49891750549828", "validator": "is_present_product", "verdict": "error"}], "limit": 10, "offset": 0, "total_results": 1}, "properties": {"data": {"items": {"properties": {"info": {"properties": {"element": {"type": "string"}}, "type": "object"}, "audit_id": {"type": "string"}, "checked_at": {"type": "string"}, "feed_types": {"items": {"type": "string"}, "type": "array"}, "id": {"type": "string"}, "level": {"type": "string"}, "product_id": {"type": "string"}, "validator": {"type": "string"}, "verdict": {"type": "string"}}, "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Feed Audits"], "description": "Returns all issues (problematic validations) of a specific audit.\n\n**OAuth2 Scope:** `projects.feedaudit.read`\n\n**GET** `https://api.mergado.com/feedaudits/id/issues/`", "summary": "List Audit Issues"}}, "/formats/": {"get": {"responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": ["heureka.cz", "hledejceny.cz", "hyperzbozi.cz", "srovname.cz", "zbozi.cz", "heureka.cz-kosik", "heureka.sk", "najnakup.sk", "pricemania.sk"]}}, "schema": {"example": ["heureka.cz", "hledejceny.cz", "hyperzbozi.cz", "srovname.cz", "zbozi.cz", "heureka.cz-kosik", "heureka.sk", "najnakup.sk", "pricemania.sk"], "items": {"type": "string"}, "type": "array"}}}, "description": "OK", "headers": {}}}, "tags": ["Base"], "description": "Returns a list of IDs of all supported XML feed's formats. **GET** `https://api.mergado.com/formats/`", "summary": "List Supported Formats"}}, "/formats/{format_id}": {"get": {"parameters": [{"description": "format ID.", "in": "path", "name": "format_id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"id": "heureka.cz", "country": "cz", "name": "Heureka.cz [cz]", "ga_sources": ["heureka.cz", "seznamzbozi.cz", "srovnanicen.cz", "nejlepsiceny.cz"], "is_importable": true, "is_exportable": true}}}, "schema": {"example": {"id": "heureka.cz", "country": "cz", "name": "Heureka.cz [cz]", "ga_sources": ["heureka.cz", "seznamzbozi.cz", "srovnanicen.cz", "nejlepsiceny.cz"], "is_importable": true, "is_exportable": true}, "type": "object", "properties": {"id": {"type": "string"}, "country": {"type": "string"}, "name": {"type": "string"}, "ga_sources": {"type": "array", "items": {"type": "string"}}, "is_importable": {"type": "boolean"}, "is_exportable": {"type": "boolean"}}}}}, "description": "OK", "headers": {}}}, "tags": ["Base"], "description": "Returns requested format by its ID.\n\n**Oauth2 Scope:** `project.read`|`shop.read`|`user.formats.read`.\n\n**GET** `https://api.mergado.com/formats/format_id`", "summary": "Get Format"}}, "/formats/{format_id}/specification": {"get": {"parameters": [{"description": "format ID.", "in": "path", "name": "format_id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"id": "xml.Heureka", "file_format": "xml", "global_schema": {"SHOP": {"semantic": "root", "mergado_xml": ["CHANNEL"], "children": {"SHOPITEM": {"mergado_xml": ["ITEM"]}}}}, "item_schema": {"ITEM_ID_DEPRECATED": {"is_deprecated": true, "is_unique": true, "semantic": "item_id", "mergado_xml": ["ITEM_ID"]}, "ITEM_ID": {"is_unique": true, "semantic": "item_id", "mergado_xml": ["ITEM_ID"]}, "PRODUCTNAME": {"is_unique": true, "semantic": "name_exact", "mergado_xml": ["NAME_EXACT"]}, "URL": {"is_unique": true, "semantic": "url", "mergado_xml": ["URL"]}, "PRODUCT": {"is_unique": true, "semantic": "name_commercial", "mergado_xml": ["NAME_COMMERCIAL"]}, "EAN": {"is_unique": true, "semantic": "ean", "mergado_xml": ["EAN"]}, "DESCRIPTION": {"semantic": "description", "mergado_xml": ["DESCRIPTION"]}, "IMGURL": {"is_unique": true, "semantic": "image", "mergado_xml": ["IMAGE"]}, "IMGURL_ALTERNATIVE": {"semantic": "image_alternative", "mergado_xml": ["IMAGE_ALTERNATIVE"]}, "VIDEO_URL": {"semantic": "video", "mergado_xml": ["VIDEO"]}, "PRICE_VAT": {"semantic": "price_vat", "mergado_xml": ["PRICE_VAT"]}, "VAT": {"semantic": "vat", "mergado_xml": ["VAT"]}, "ITEM_TYPE": {"semantic": "item_type"}, "PARAM": {"semantic": "param", "mergado_xml": ["PARAM"], "children": {"PARAM_NAME": {"semantic": "param_name", "mergado_xml": ["NAME"]}, "VAL": {"semantic": "param_value", "mergado_xml": ["VALUE"]}}}, "MANUFACTURER": {"semantic": "brand", "mergado_xml": ["BRAND"]}, "CATEGORYTEXT": {"semantic": "category", "mergado_xml": ["CATEGORY"]}, "ISBN": {"is_unique": true, "semantic": "isbn", "mergado_xml": ["ISBN"]}, "HEUREKA_CPC": {"semantic": "cpc", "mergado_xml": ["CPC"]}, "DELIVERY_DATE": {"semantic": "delivery_days", "mergado_xml": ["DELIVERY_DAYS"]}, "DELIVERY": {"semantic": "delivery", "mergado_xml": ["DELIVERY"], "children": {"DELIVERY_ID": {"semantic": "delivery_id", "mergado_xml": ["ID"]}, "DELIVERY_PRICE": {"semantic": "delivery_price", "mergado_xml": ["PRICE"]}, "DELIVERY_PRICE_COD": {"semantic": "delivery_price_cod", "mergado_xml": ["PRICE_COD"]}}}, "ITEMGROUP_ID": {"semantic": "itemgroup_id", "mergado_xml": ["ITEMGROUP_ID"]}, "ACCESSORY": {"semantic": "accessory", "mergado_xml": ["ACCESSORY"]}, "DUES": {"semantic": "dues", "mergado_xml": ["DUES"]}, "GIFT": {"semantic": "benefit", "mergado_xml": ["BENEFIT"], "children": {"ID": {"is_attribute": true, "semantic": "gift_id"}}}, "EXTENDED_WARRANTY": {"semantic": "extended_warranty_wrapper", "children": {"VAL": {"semantic": "warranty", "mergado_xml": ["WARRANTY"]}, "DESC": {"semantic": "extended_warranty_description"}}}, "SPECIAL_SERVICE": {"semantic": "benefit", "mergado_xml": ["BENEFIT"]}, "SALES_VOUCHER": {"semantic": "voucher", "children": {"CODE": {"semantic": "voucher_code"}, "DESC": {"semantic": "voucher_description"}}}}}}}, "schema": {"type": "object", "properties": {"id": {"type": "string"}, "file_format": {"type": "string"}, "global_schema": {"type": "object"}, "item_schema": {"type": "object"}}}}}, "description": "OK", "headers": {}}}, "tags": ["Base"], "description": "Returns requested format specification by its format ID. \n\n**Warning:** Format specifications could be changed to be up to date with the newest versions provided by the format authors.\n\n**Oauth2 Scope:** `project.read`|`shop.read`|`user.formats.read`.\n\n**GET** `https://api.mergado.com/formats/format_id/specification`.", "summary": "Get Format Specification"}}, "/heureka/categories/": {"get": {"responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": [{"children": [{"id": "2210", "name": "Auto-moto"}, {"id": "2209", "name": "Bílé zboží"}], "full_name": "Heureka.cz", "heureka_id": "123", "id": "1", "min_cpcs": [], "name": "Heureka.cz", "parent": null}, {"children": [{"id": "5", "name": "Auto-moto"}, {"id": "15", "name": "Biela technika"}], "full_name": "Heureka.sk", "heureka_id": "768", "id": "2", "min_cpcs": [], "name": "Heureka.sk", "parent": null}]}}, "schema": {"example": [{"children": [{"id": "2210", "name": "Auto-moto"}, {"id": "2209", "name": "Bílé zboží"}], "full_name": "Heureka.cz", "heureka_id": "123", "id": "1", "min_cpcs": [], "name": "Heureka.cz", "parent": null}, {"children": [{"id": "5", "name": "Auto-moto"}, {"id": "15", "name": "Biela technika"}], "full_name": "Heureka.sk", "heureka_id": "768", "id": "2", "min_cpcs": [], "name": "Heureka.sk", "parent": null}], "items": {"properties": {"children": {"items": {"properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"], "type": "object"}, "type": "array"}, "full_name": {"type": "string"}, "heureka_id": {"type": "string"}, "id": {"type": "string"}, "min_cpcs": {"items": {}, "type": "array"}, "name": {"type": "string"}, "parent": {"nullable": true}}, "required": ["id", "name", "full_name", "heureka_id", "parent", "children", "min_cpcs"], "type": "object"}, "type": "array"}}}, "description": "OK", "headers": {}}}, "tags": ["Heureka Categories"], "description": "Returns list of all Heureka categories. **GET** `hhttps://api.mergado.com/heureka/categories/`", "summary": "List Categories"}}, "/heureka/categories/{id}/": {"get": {"parameters": [{"description": "ID of the category.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"children": [{"id": "463", "name": "Hracie karty - poker"}, {"id": "464", "name": "Poker sady"}, {"id": "465", "name": "Príslušenstvo pre poker"}, {"id": "466", "name": "Stoly na poker"}, {"id": "467", "name": "Žetóny - poker"}], "full_name": "Šport | Poker", "heureka_id": "502", "id": "68", "min_cpcs": [{"to_price": "10.0", "value": 0.03}, {"to_price": "40.0", "value": 0.05}, {"to_price": "110.0", "value": 0.05}, {"to_price": "185.0", "value": 0.07}, {"to_price": "370.0", "value": 0.09}, {"to_price": null, "value": 0.11}], "name": "Poker", "parent": {"id": "7", "name": "Šport"}}}}, "schema": {"example": {"children": [{"id": "463", "name": "Hracie karty - poker"}, {"id": "464", "name": "Poker sady"}, {"id": "465", "name": "Príslušenstvo pre poker"}, {"id": "466", "name": "Stoly na poker"}, {"id": "467", "name": "Žetóny - poker"}], "full_name": "Šport | Poker", "heureka_id": "502", "id": "68", "min_cpcs": [{"to_price": "10.0", "value": 0.03}, {"to_price": "40.0", "value": 0.05}, {"to_price": "110.0", "value": 0.05}, {"to_price": "185.0", "value": 0.07}, {"to_price": "370.0", "value": 0.09}, {"to_price": null, "value": 0.11}], "name": "Poker", "parent": {"id": "7", "name": "Šport"}}, "properties": {"children": {"items": {"properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"], "type": "object"}, "type": "array"}, "full_name": {"type": "string"}, "heureka_id": {"type": "string"}, "id": {"type": "string"}, "min_cpcs": {"items": {"properties": {"to_price": {"nullable": true, "type": "string"}, "value": {"type": "number"}}, "required": ["to_price", "value"], "type": "object"}, "type": "array"}, "name": {"type": "string"}, "parent": {"properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "type": "object"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Heureka Categories"], "description": "Returns a single Heureka category. **GET** `https://api.mergado.com/heureka/categories/id/`", "summary": "Get a Category"}}, "/importlogs/{id}/": {"get": {"parameters": [{"description": "ID of a log.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"duration": 2.352, "finished_at": "2016-05-18T15:16:25+00:00", "id": "75", "items": 1, "items_created": 1, "items_processed": 1, "items_removed": 0, "items_updated": 0, "started_at": "2016-05-18T15:16:23+00:00", "user_id": "1"}}}, "schema": {"example": {"duration": 2.352, "finished_at": "2016-05-18T15:16:25+00:00", "id": "75", "items": 1, "items_created": 1, "items_processed": 1, "items_removed": 0, "items_updated": 0, "started_at": "2016-05-18T15:16:23+00:00", "user_id": "1"}, "properties": {"duration": {"type": "number"}, "finished_at": {"type": "string"}, "id": {"type": "string"}, "items": {"type": "number"}, "items_created": {"type": "number"}, "items_processed": {"type": "number"}, "items_removed": {"type": "number"}, "items_updated": {"type": "number"}, "started_at": {"type": "string"}, "user_id": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Logs"], "description": "Fetches an import log with the given ID.\n\n**OAuth2 Scope:** `project.logs.read`\n\n**GET** `https://api.mergado.com/importlogs/id/`", "summary": "Get an Import Log"}}, "/maintenance": {"get": {"responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"from": "2018-08-08T13:00:00+00:00", "to": "2018-08-08T13:30:00+00:00", "type": "scheduled_maintenance"}, {"from": "2018-07-26T13:00:00+00:00", "to": "2018-07-26T13:15:00+00:00", "type": "scheduled_maintenance"}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"type": "object", "properties": {"data": {"type": "array", "items": {"type": "object", "properties": {"from": {"type": "string"}, "to": {"type": "string"}, "type": {"type": "string"}}}}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "example": {"data": [{"from": "2018-08-08T13:00:00+00:00", "to": "2018-08-08T13:30:00+00:00", "type": "scheduled_maintenance"}, {"from": "2018-07-26T13:00:00+00:00", "to": "2018-07-26T13:15:00+00:00", "type": "scheduled_maintenance"}], "limit": 10, "offset": 0, "total_results": 2}}}}, "description": "OK", "headers": {}}}, "tags": ["Base"], "description": "Returns information about maintenance. **GET** `https://api.mergado.com/maintenance`", "summary": "Show maintenance info"}}, "/me/": {"get": {"responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"city": "Brno", "company": "Mergado", "country": "cz", "dic": "00000000", "email": "lorem.ipsum@example.com", "fakturoid_id": null, "first_name": "Lorem", "ico": "00000000", "id": "6", "invoice_months": 1, "last_access": "2016-03-21T16:32:32+00:00", "last_name": "Ipsum", "locale": "cs_CZ", "name": "Lorem Ipsum", "postcode": "61200", "registered_at": "2015-11-03T16:08:17+00:00", "send_summary": false, "street": "Palackého 123/456", "timezone": "Europe/Prague", "timezone_offset": null, "username": "loremipsum"}}}, "schema": {"example": {"city": "Brno", "company": "Mergado", "country": "cz", "dic": "00000000", "email": "lorem.ipsum@example.com", "fakturoid_id": null, "first_name": "Lorem", "ico": "00000000", "id": "6", "invoice_months": 1, "last_access": "2016-03-21T16:32:32+00:00", "last_name": "Ipsum", "locale": "cs_CZ", "name": "Lorem Ipsum", "postcode": "61200", "registered_at": "2015-11-03T16:08:17+00:00", "send_summary": false, "street": "Palackého 123/456", "timezone": "Europe/Prague", "timezone_offset": null, "username": "loremipsum"}, "properties": {"city": {"type": "string"}, "company": {"type": "string"}, "country": {"type": "string"}, "dic": {"type": "string"}, "email": {"type": "string"}, "fakturoid_id": {"nullable": true}, "first_name": {"type": "string"}, "ico": {"type": "string"}, "id": {"type": "string"}, "invoice_months": {"type": "number"}, "last_access": {"type": "string"}, "last_name": {"type": "string"}, "locale": {"type": "string"}, "name": {"type": "string"}, "postcode": {"type": "string"}, "registered_at": {"type": "string"}, "send_summary": {"type": "boolean"}, "street": {"type": "string"}, "timezone": {"type": "string"}, "timezone_offset": {"nullable": true}, "username": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Me"], "description": "**Access with ONLINE token only.**\n\nReturns currently authenticated user.\n\n**OAuth2 Scope:** `user.read`\n\n**GET** `https://api.mergado.com/me/`", "summary": "User"}}, "/me/app/enabled/": {"get": {"responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"entity_id": 100, "free_until": "2021-11-05", "is_enabled": true, "paid_until": "2021-12-07"}, {"entity_id": 101, "free_until": "2021-06-05", "is_enabled": true, "paid_until": "2021-08-06"}, {"entity_id": 200, "free_until": "2021-02-05", "is_enabled": false, "paid_until": "2021-04-03"}], "limit": 10, "offset": 0, "total_results": 3}}}, "schema": {"example": {"data": [{"entity_id": 100, "free_until": "2021-11-05", "is_enabled": true, "paid_until": "2021-12-07"}, {"entity_id": 101, "free_until": "2021-06-05", "is_enabled": true, "paid_until": "2021-08-06"}, {"entity_id": 200, "free_until": "2021-02-05", "is_enabled": false, "paid_until": "2021-04-03"}], "limit": 10, "offset": 0, "total_results": 3}, "properties": {"data": {"items": {"properties": {"entity_id": {"type": "number"}, "free_until": {"type": "string"}, "is_enabled": {"type": "boolean"}, "paid_until": {"type": "string"}}, "required": ["entity_id", "is_enabled", "free_until", "paid_until"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Me"], "description": "**Access with OFFLINE token only.**\n\nReturns list of entities _(user, shop, project, based on your app type)_ where your Mergado platform app was enabled at least once. The list is sorted from the newest entries to the oldest ones. **GET** `https://api.mergado.com/me/app/enabled/`", "summary": "List enabled instances"}}, "/me/app/enabled/{entity_id}": {"get": {"parameters": [{"description": "Entity ID *(user, shop, project, based on your app type)*.", "in": "path", "name": "entity_id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"disabled_at": null, "disabled_by_user_id": null, "enabled_at": "2020-11-05T09:08:19+00:00", "enabled_by_user_id": 1003}, {"disabled_at": "2021-02-16T12:43:26+00:00", "disabled_by_user_id": 1003, "enabled_at": "2020-11-05T09:08:19+00:00", "enabled_by_user_id": 1001}], "limit": 10, "offset": 0, "total_results": 1}}}, "schema": {"example": {"data": [{"disabled_at": null, "disabled_by_user_id": null, "enabled_at": "2020-11-05T09:08:19+00:00", "enabled_by_user_id": 1003}, {"disabled_at": "2021-02-16T12:43:26+00:00", "disabled_by_user_id": 1003, "enabled_at": "2020-11-05T09:08:19+00:00", "enabled_by_user_id": 1001}], "limit": 10, "offset": 0, "total_results": 1}, "properties": {"data": {"items": {"properties": {"disabled_at": {"nullable": true, "type": "string"}, "disabled_by_user_id": {"nullable": true, "type": "number"}, "enabled_at": {"type": "string"}, "enabled_by_user_id": {"type": "number"}}, "required": ["enabled_at", "enabled_by_user_id", "disabled_at", "disabled_by_user_id"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Me"], "description": "**Access with OFFLINE token only.**\n\nReturns history of enabled/disabled state of your app for a specific entity ID.\n\n**GET** `https://api.mergado.com/me/app/enabled/entity_id`", "summary": "Get app history for entity"}}, "/notifications/{id}/": {"get": {"parameters": [{"description": "ID of a notification.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "Comma separated list of field names to return.", "in": "query", "name": "fields", "required": false, "schema": {"type": "string"}}], "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": {"id": "30", "event": "app_notify", "data": {"title": "E-shop is happy", "body": "There seems not to be a problem with your eshop."}, "channels": ["frontend", "email"], "created_at": "2016-05-11T14:43:18+00:00", "priority": "high", "scope": "owner"}}}, "schema": {"type": "object", "properties": {"id": {"type": "string"}, "event": {"type": "string", "description": "Type of event, e.g. app_notify for notifications sent by Mergado platform apps via API."}, "data": {"type": "object", "properties": {"title": {"type": "string"}, "body": {"type": "string"}}}, "channels": {"type": "array", "items": {"type": "string"}}, "created_at": {"type": "string", "description": "When was notification created."}, "priority": {"type": "string"}, "scope": {"type": "string"}}}}}, "description": "Created", "headers": {}}}, "tags": ["Notifications"], "description": "**OAuth2 Scope:** `user.notify.read`.\n\n**GET** `https://api.mergado.com/notifications/id/?fields=`\n\n**Attributes:**\n* **id (string):** Notification ID.\n* **event (string):** Type of event, e.g. `app_notify` for notifications sent by Mergado platform apps via API.\n* **created_at (string):** When was notification created.\n* **channels (enum):** List of delivery channels (e.g., frontend, email).\n* **priority (enum):** Importance level of the notification.\n* **scope (enum):** Visibility scope (e.g., owner).\n* **data (object):** Additional notification data (title, body).\n---", "summary": "Get a notification"}}, "/pairings/{id}/": {"get": {"parameters": [{"description": "ID of a pairing.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"id": "1693", "created_at": "2016-04-28T17:18:50+00:00", "deleted_at": "2019-03-27T17:18:45+00:00"}}}, "schema": {"properties": {"id": {"type": "string"}, "created_at": {"type": "string"}, "deleted_at": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Pairings"], "description": "Returns a pairing with the given ID.\n\n**OAuth2 Scope:** `project.products.read`\n\n**GET** `https://api.mergado.com/pairings/id/`", "summary": "Get a Pairing"}}, "/products/{id}/": {"get": {"parameters": [{"description": "ID of a product.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": {"attributes": {"TOP_LEVEL_ATTRIBUTE": {"value": "123"}}, "elements": {"IMAGE": [{"value": "img 1"}, {"value": "img 2"}, {"value": "img 3"}], "ITEM_ID": [{"attributes": {"id": "456"}, "input_value": "123", "value": "123"}], "PARAM": [{"elements": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Černá"}]}}, {"elements": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Modrá"}]}, "value": "value of PARAM"}], "PRICE": [{"input_value": 69, "value": 69}]}}, "id": "1693", "output_changed_at": null, "updated_at": "2016-04-28T17:18:50+00:00"}}}, "schema": {"example": {"data": {"attributes": {"TOP_LEVEL_ATTRIBUTE": {"value": "123"}}, "elements": {"IMAGE": [{"value": "img 1"}, {"value": "img 2"}, {"value": "img 3"}], "ITEM_ID": [{"attributes": {"id": "456"}, "input_value": "123", "value": "123"}], "PARAM": [{"elements": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Černá"}]}}, {"elements": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Modrá"}]}, "value": "value of PARAM"}], "PRICE": [{"input_value": 69, "value": 69}]}}, "id": "1693", "output_changed_at": null, "updated_at": "2016-04-28T17:18:50+00:00"}, "properties": {"data": {"properties": {"attributes": {"properties": {"TOP_LEVEL_ATTRIBUTE": {"properties": {"value": {"type": "string"}}, "type": "object"}}, "type": "object"}, "elements": {"properties": {"IMAGE": {"items": {"properties": {"value": {"type": "string"}}, "required": ["value"], "type": "object"}, "type": "array"}, "ITEM_ID": {"items": {"properties": {"attributes": {"properties": {"id": {"type": "string"}}, "type": "object"}, "input_value": {"type": "string"}, "value": {"type": "string"}}, "type": "object"}, "type": "array"}, "PARAM": {"items": {"properties": {"elements": {"properties": {"NAME": {"items": {"properties": {"value": {"type": "string"}}, "required": ["value"], "type": "object"}, "type": "array"}, "VAL": {"items": {"properties": {"value": {"type": "string"}}, "required": ["value"], "type": "object"}, "type": "array"}}, "type": "object"}, "value": {"type": "string"}}, "required": ["elements"], "type": "object"}, "type": "array"}, "PRICE": {"items": {"properties": {"input_value": {"type": "number"}, "value": {"type": "number"}}, "type": "object"}, "type": "array"}}, "type": "object"}}, "type": "object"}, "id": {"type": "string"}, "output_changed_at": {"nullable": true}, "updated_at": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Products"], "description": "Returns a product with the given ID.\n\n**OAuth2 Scope:** `project.products.read`\n\n**GET** `https://api.mergado.com/products/id/`", "summary": "Get a Product"}, "patch": {"parameters": [{"description": "ID of a product.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": {"CATEGORYTEXT": "Tonery do tiskáren > Kompatibilní tonery", "DELIVERY_DATE": "0", "DESCRIPTION": "Toner HP Q7551X", "DUES": "0", "IMGURL": "http://www.example.com/img/755.jpg", "MANUFACTURER": "PIRANHA", "PRICE": "808.18", "PRODUCT": "Toner HP Q7551X", "URL": "http://www.comps.cz/toner-hp-755", "VAT": "21.0"}, "id": "1693", "input_data": {"CATEGORYTEXT": "Tonery do tiskáren | Kompatibilní tonery", "DELIVERY_DATE": "0", "DESCRIPTION": "Toner HP Q7551X", "DUES": "0", "IMGURL": "http://www.example.com/img/755.jpg", "MANUFACTURER": "PIRANHA", "PRICE": "808.18", "PRODUCT": "Toner HP Q7551X", "URL": "http://www.comps.cz/toner-hp-755", "VAT": "21.0"}, "output_changed_at": null, "updated_at": "2017-05-21T00:00:00+00:00"}}}, "schema": {"example": {"data": {"CATEGORYTEXT": "Tonery do tiskáren > Kompatibilní tonery", "DELIVERY_DATE": "0", "DESCRIPTION": "Toner HP Q7551X", "DUES": "0", "IMGURL": "http://www.example.com/img/755.jpg", "MANUFACTURER": "PIRANHA", "PRICE": "808.18", "PRODUCT": "Toner HP Q7551X", "URL": "http://www.comps.cz/toner-hp-755", "VAT": "21.0"}, "id": "1693", "input_data": {"CATEGORYTEXT": "Tonery do tiskáren | Kompatibilní tonery", "DELIVERY_DATE": "0", "DESCRIPTION": "Toner HP Q7551X", "DUES": "0", "IMGURL": "http://www.example.com/img/755.jpg", "MANUFACTURER": "PIRANHA", "PRICE": "808.18", "PRODUCT": "Toner HP Q7551X", "URL": "http://www.comps.cz/toner-hp-755", "VAT": "21.0"}, "output_changed_at": null, "updated_at": "2017-05-21T00:00:00+00:00"}, "properties": {"data": {"properties": {"CATEGORYTEXT": {"type": "string"}, "DELIVERY_DATE": {"type": "string"}, "DESCRIPTION": {"type": "string"}, "DUES": {"type": "string"}, "IMGURL": {"type": "string"}, "MANUFACTURER": {"type": "string"}, "PRICE": {"type": "string"}, "PRODUCT": {"type": "string"}, "URL": {"type": "string"}, "VAT": {"type": "string"}}, "type": "object"}, "id": {"type": "string"}, "input_data": {"properties": {"CATEGORYTEXT": {"type": "string"}, "DELIVERY_DATE": {"type": "string"}, "DESCRIPTION": {"type": "string"}, "DUES": {"type": "string"}, "IMGURL": {"type": "string"}, "MANUFACTURER": {"type": "string"}, "PRICE": {"type": "string"}, "PRODUCT": {"type": "string"}, "URL": {"type": "string"}, "VAT": {"type": "string"}}, "type": "object"}, "output_changed_at": {"nullable": true}, "updated_at": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Products"], "description": "Updates a product with the given ID.\n\n**Note:** Currently, it is possible to update only the field `is_dirty` which can be used\nto force Mergado to refresh the product (apply rules) during the next (lazy) rebuild.\n\nFor optimization reasons, this field is not returned in the response, and whether the product\nhas already been applied can be checked in the logs at `/projects//applylogs/`.\nNevertheless, it is acceptable to mark the product as dirty without prior checking to see if it is even necessary.\n\n**OAuth2 Scope:** `project.products.write`.\n\n**PATCH** `https://api.mergado.com/products/id/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"is_dirty": true}, "properties": {"is_dirty": {"type": "boolean"}}, "type": "object"}}}}, "summary": "Update a Product"}}, "/products/{id}/stats/": {"get": {"parameters": [{"description": "ID of the product.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "Date of the collection of the statistics.", "in": "query", "name": "date", "required": false, "schema": {"type": "string"}}, {"description": "The lower bound of the stats range.", "in": "query", "name": "start_date", "required": false, "schema": {"type": "string"}}, {"description": "The upper bound of the stats range.", "in": "query", "name": "end_date", "required": false, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"date": "2018-08-08", "product_id": "2550458", "stats": {"heureka_actual_cpc": 1.5, "heureka_card_name": "TFA 30.5027.02", "heureka_category": "Měřiče teploty a vlhkosti", "heureka_categorytext": "Zvlhčovače vzduchu", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 0, "heureka_feed_cpc": 12.65, "heureka_id": "123", "heureka_imgurl": "https://www.example.cz/eshop/data/1001/img/vlhkoměr_TFA.jpg", "heureka_manufacturer": "TFA", "heureka_max_prices": [350, 350, 350, 350, 350, 350], "heureka_min_cpc": 1.5, "heureka_min_price": 350, "heureka_min_prices": [350, 350, 350, 350, 350, 350], "heureka_name": "Teploměr s vlhkoměrem TFA 30.5027.02", "heureka_popularity": 53, "heureka_price_position": 1, "heureka_price_vat": 350, "heureka_sales": 0, "heureka_segment": "Stavebniny", "heureka_shop_url": "https://www.example.cz/eshop/teplomer-s-vlhkomerem-tfa-30-5027-02.html", "heureka_shops_count": 6, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://merice-teploty-vlhkosti.heureka.cz/tfa-30_5027_02", "item_id": "1001"}}, {"date": "2018-08-07", "product_id": "2550458", "stats": {"heureka_actual_cpc": 1.5, "heureka_card_name": "TFA 30.5027.02", "heureka_category": "Měřiče teploty a vlhkosti", "heureka_categorytext": "Zvlhčovače vzduchu", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 0, "heureka_feed_cpc": 11.98, "heureka_id": "124", "heureka_imgurl": "https://www.example.cz/eshop/data/1001/img/vlhkoměr_TFA.jpg", "heureka_manufacturer": "TFA", "heureka_max_prices": [350, 350, 350, 350, 350, 350], "heureka_min_cpc": 1.5, "heureka_min_price": 350, "heureka_min_prices": [350, 350, 350, 350, 350, 350], "heureka_name": "Teploměr s vlhkoměrem TFA 30.5027.02", "heureka_popularity": 53, "heureka_price_position": 1, "heureka_price_vat": 350, "heureka_sales": 0, "heureka_segment": "Stavebniny", "heureka_shop_url": "https://www.example.cz/eshop/teplomer-s-vlhkomerem-tfa-30-5027-02.html", "heureka_shops_count": 6, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://merice-teploty-vlhkosti.heureka.cz/tfa-30_5027_02", "item_id": "1001"}}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"example": {"data": [{"date": "2018-08-08", "product_id": "2550458", "stats": {"heureka_actual_cpc": 1.5, "heureka_card_name": "TFA 30.5027.02", "heureka_category": "Měřiče teploty a vlhkosti", "heureka_categorytext": "Zvlhčovače vzduchu", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 0, "heureka_feed_cpc": 12.65, "heureka_id": "123", "heureka_imgurl": "https://www.example.cz/eshop/data/1001/img/vlhkoměr_TFA.jpg", "heureka_manufacturer": "TFA", "heureka_max_prices": [350, 350, 350, 350, 350, 350], "heureka_min_cpc": 1.5, "heureka_min_price": 350, "heureka_min_prices": [350, 350, 350, 350, 350, 350], "heureka_name": "Teploměr s vlhkoměrem TFA 30.5027.02", "heureka_popularity": 53, "heureka_price_position": 1, "heureka_price_vat": 350, "heureka_sales": 0, "heureka_segment": "Stavebniny", "heureka_shop_url": "https://www.example.cz/eshop/teplomer-s-vlhkomerem-tfa-30-5027-02.html", "heureka_shops_count": 6, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://merice-teploty-vlhkosti.heureka.cz/tfa-30_5027_02", "item_id": "1001"}}, {"date": "2018-08-07", "product_id": "2550458", "stats": {"heureka_actual_cpc": 1.5, "heureka_card_name": "TFA 30.5027.02", "heureka_category": "Měřiče teploty a vlhkosti", "heureka_categorytext": "Zvlhčovače vzduchu", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 0, "heureka_feed_cpc": 11.98, "heureka_id": "124", "heureka_imgurl": "https://www.example.cz/eshop/data/1001/img/vlhkoměr_TFA.jpg", "heureka_manufacturer": "TFA", "heureka_max_prices": [350, 350, 350, 350, 350, 350], "heureka_min_cpc": 1.5, "heureka_min_price": 350, "heureka_min_prices": [350, 350, 350, 350, 350, 350], "heureka_name": "Teploměr s vlhkoměrem TFA 30.5027.02", "heureka_popularity": 53, "heureka_price_position": 1, "heureka_price_vat": 350, "heureka_sales": 0, "heureka_segment": "Stavebniny", "heureka_shop_url": "https://www.example.cz/eshop/teplomer-s-vlhkomerem-tfa-30-5027-02.html", "heureka_shops_count": 6, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://merice-teploty-vlhkosti.heureka.cz/tfa-30_5027_02", "item_id": "1001"}}], "limit": 10, "offset": 0, "total_results": 2}, "properties": {"data": {"items": {"properties": {"date": {"type": "string"}, "product_id": {"type": "string"}, "stats": {"properties": {"heureka_actual_cpc": {"type": "number"}, "heureka_card_name": {"type": "string"}, "heureka_category": {"type": "string"}, "heureka_categorytext": {"type": "string"}, "heureka_clicks": {"type": "number"}, "heureka_cost_of_sales": {"type": "number"}, "heureka_cpc": {"type": "number"}, "heureka_delivery_date": {"type": "number"}, "heureka_feed_cpc": {"type": "number"}, "heureka_id": {"type": "string"}, "heureka_imgurl": {"type": "string"}, "heureka_manufacturer": {"type": "string"}, "heureka_max_prices": {"items": {"type": "number"}, "type": "array"}, "heureka_min_cpc": {"type": "number"}, "heureka_min_price": {"type": "number"}, "heureka_min_prices": {"items": {"type": "number"}, "type": "array"}, "heureka_name": {"type": "string"}, "heureka_popularity": {"type": "number"}, "heureka_price_position": {"type": "number"}, "heureka_price_vat": {"type": "number"}, "heureka_sales": {"type": "number"}, "heureka_segment": {"type": "string"}, "heureka_shop_url": {"type": "string"}, "heureka_shops_count": {"type": "number"}, "heureka_total_cost": {"type": "number"}, "heureka_total_orders": {"type": "number"}, "heureka_url": {"type": "string"}, "item_id": {"type": "string"}}, "type": "object"}}, "required": ["date", "stats", "product_id"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Statistics"], "description": "Returns a list of product statistics relevant to the project format.\nThe stats are collected daily.\n\n**OAuth2 Scope:** `project.stats.read`\n\n**GET** `https://api.mergado.com/products/id/stats/?date=&start_date=&end_date=`", "summary": "Statistics of a Product"}}, "/project/{id}/products/": {"patch": {"parameters": [{"description": "ID of a product.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content", "headers": {}}}, "tags": ["Products"], "description": "Updates all products or products matching the filter. It is possible to use filters which are for the **GET** request,\ne.g. `?filter=[{\"field\": \"id\",\"op\": \"in\", \"value\": \"[123, 124]\"}]`.\n\n**Note:** Currently, it is possible tu update only the field `is_dirty` which can be used\nto force Mergado to refresh the products (apply rules) during the next (lazy) rebuild.\n\nFor optimization reasons, nothing is returned in the response, and whether the products have\nhas already been applied can be checked in the logs at `/projects//applylogs/`.\nNevertheless, it is acceptable to mark the product as dirty without prior checking to see if it is even necessary.\n\n**OAuth2 Scope:** `project.products.write`\n\n**PATCH** `https://api.mergado.com/project/id/products/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"is_dirty": true}, "properties": {"is_dirty": {"type": "boolean"}}, "type": "object"}}}}, "summary": "Update products"}}, "/project/{id}/variables/": {"post": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": {"element_path": "DESCRIPTION", "fragment_number": 2, "id": "1521", "name": "DESCRIPTION_A", "project_id": "33", "regular_expression": "(\\-|\\* )?(.*)", "sample_text": null, "type": "manual"}}}, "schema": {"example": {"element_path": "DESCRIPTION", "fragment_number": 2, "id": "1521", "name": "DESCRIPTION_A", "project_id": "33", "regular_expression": "(\\-|\\* )?(.*)", "sample_text": null, "type": "manual"}, "properties": {"element_path": {"type": "string"}, "fragment_number": {"type": "number"}, "id": {"type": "string"}, "name": {"type": "string"}, "project_id": {"type": "string"}, "regular_expression": {"type": "string"}, "sample_text": {"nullable": true}, "type": {"type": "string"}}, "type": "object"}}}, "description": "Created", "headers": {"Location": {"schema": {"type": "string"}}}}}, "tags": ["Variables"], "description": "Creates a new variable inside a project.\n\n**OAuth2 Scope:** `project.variables.write`\n\n**POST** `https://api.mergado.com/project/id/variables/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"element_path": "DESCRIPTION", "fragment_number": 2, "name": "DESCRIPTION_A", "regular_expression": "(\\-|\\* )?(.*)", "sample_text": null}, "properties": {"element_path": {"type": "string"}, "fragment_number": {"type": "number"}, "name": {"type": "string"}, "regular_expression": {"type": "string"}, "sample_text": {"nullable": true}}, "type": "object"}}}}, "summary": "Create a Variable"}}, "/projects/{id}/": {"get": {"parameters": [{"description": "ID of a project.Re", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"id": "8", "shop_id": "1", "creator_id": "1", "name": "Billiger.de", "url": "https://dummy.mergado.com/example-com.xml", "created": "2015-11-11T15:42:33+00:00", "exported_items": 0, "input_format": "zbozi.cz", "output_format": "billiger.de", "pairing_elements": "URL", "readonly": false, "is_paused": false, "rules_changed_at": "2015-11-11T15:43:07+00:00", "slug": "example-com-heureka-cz-asdf", "turned_off": true, "update_period": 14400, "last_access": "2015-12-10T12:51:59+00:00", "data_synced_at": "2015-11-18T13:19:59+00:00", "data_updated_at": "2015-11-11T15:42:50+00:00", "is_dirty": false, "in_testing_mode": false, "metadata": {"stats_ga_medium": "agregator", "stats_ga_source": "heureka.*.", "generator": "mergado.magento.marketingpack.0_1"}, "number_of_elements": 28, "all_products_query_id": "1", "sync_schedule": {"minute": "50", "hour": "*/1", "day_of_week": "*", "day_of_month": "*", "month_of_year": "*"}}}}, "schema": {"type": "object", "properties": {"id": {"type": "string"}, "shop_id": {"type": "string"}, "creator_id": {"type": "string"}, "name": {"type": "string"}, "url": {"type": "string"}, "created": {"type": "string"}, "exported_items": {"type": "integer"}, "input_format": {"type": "string"}, "output_format": {"type": "string"}, "pairing_elements": {"type": "string"}, "readonly": {"type": "boolean"}, "is_paused": {"type": "boolean"}, "rules_changed_at": {"type": "string"}, "slug": {"type": "string"}, "turned_off": {"type": "boolean"}, "update_period": {"type": "integer"}, "last_access": {"type": "string"}, "data_synced_at": {"type": "string"}, "data_updated_at": {"type": "string"}, "is_dirty": {"type": "boolean"}, "in_testing_mode": {"type": "boolean"}, "metadata": {"type": "object", "properties": {"stats_ga_medium": {"type": "string"}, "stats_ga_source": {"type": "string"}, "generator": {"type": "string"}}}, "number_of_elements": {"type": "integer"}, "all_products_query_id": {"type": "string"}, "sync_schedule": {"type": "object", "properties": {"minute": {"type": "string"}, "hour": {"type": "string"}, "day_of_week": {"type": "string"}, "day_of_month": {"type": "string"}, "month_of_year": {"type": "string"}}}}}}}, "description": "OK", "headers": {}}}, "tags": ["Projects"], "description": "Returns a project with the given ID. If the requested project is not active, the endpoint returns 404\n\n**OAuth2 Scope:** `project.read`\n\n**GET** `https://api.mergado.com/projects/id/`", "summary": "Get a Project"}, "patch": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Projects"], "description": "Updates a project with the given ID.\n\n**Note:** Currently, it is possible to update only the field `is_dirty` which can be used\nto force Mergado to refresh the products (apply rules) during the next (lazy) rebuild.\n\nFor optimization reasons, this field is not returned in the response, and whether the product\nhas already been applied can be checked in the logs at `/projects//applylogs/`.\nNevertheless, it is acceptable to mark the product as dirty without prior checking to see if it is even necessary.\n\n**OAuth2 Scope:** `project.write`\n\n**PATCH** `https://api.mergado.com/projects/id/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"is_dirty": true}, "properties": {"is_dirty": {"type": "boolean"}}, "type": "object"}}}}, "summary": "Update a Project"}}, "/projects/{id}/accesslogs/": {"get": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"https": false, "id": "101", "identity": "-", "ip": "111.222.333.444", "referer": "-", "request": "GET /mergadovenaradie-cz-heureka-cz-greagfsdabtrshthgreav.xml HTTP/1.1", "size": 627142, "status": 200, "time": "2016-05-15T08:18:13+00:00", "user": "-", "user_agent": "Heurekabot-Feed/1.0 (+http://sluzby.heureka.cz/napoveda/heurekabot/)"}, {"https": false, "id": "127", "identity": "-", "ip": "555.666.777.888", "referer": "-", "request": "HEAD /naradiovemergado-cz-kurtmjyrasnaENBREANzgtsf.xml HTTP/1.1", "size": 0, "status": 200, "time": "2016-05-15T08:24:38+00:00", "user": "-", "user_agent": "Mozilla/5.0 (Windows; U; Windows NT 5.1; cs; rv:1) Gecko/20101203 Firefox/3.6.13 ( .NET CLR 1)"}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"example": {"data": [{"https": false, "id": "101", "identity": "-", "ip": "111.222.333.444", "referer": "-", "request": "GET /mergadovenaradie-cz-heureka-cz-greagfsdabtrshthgreav.xml HTTP/1.1", "size": 627142, "status": 200, "time": "2016-05-15T08:18:13+00:00", "user": "-", "user_agent": "Heurekabot-Feed/1.0 (+http://sluzby.heureka.cz/napoveda/heurekabot/)"}, {"https": false, "id": "127", "identity": "-", "ip": "555.666.777.888", "referer": "-", "request": "HEAD /naradiovemergado-cz-kurtmjyrasnaENBREANzgtsf.xml HTTP/1.1", "size": 0, "status": 200, "time": "2016-05-15T08:24:38+00:00", "user": "-", "user_agent": "Mozilla/5.0 (Windows; U; Windows NT 5.1; cs; rv:1) Gecko/20101203 Firefox/3.6.13 ( .NET CLR 1)"}], "limit": 10, "offset": 0, "total_results": 2}, "properties": {"data": {"items": {"properties": {"https": {"type": "boolean"}, "id": {"type": "string"}, "identity": {"type": "string"}, "ip": {"type": "string"}, "referer": {"type": "string"}, "request": {"type": "string"}, "size": {"type": "number"}, "status": {"type": "number"}, "time": {"type": "string"}, "user": {"type": "string"}, "user_agent": {"type": "string"}}, "required": ["https", "id", "identity", "ip", "referer", "request", "size", "status", "time", "user", "user_agent"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Logs"], "description": "Fetches all access logs for given project.\n\n**OAuth2 Scope:** `project.logs.read`\n\n**GET** `https://api.mergado.com/projects/id/accesslogs/`", "summary": "Get Access Logs"}}, "/projects/{id}/applylogs/": {"get": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"applied_to_all_items": true, "duration": 1.548, "finished_at": "2016-05-18T15:16:26+00:00", "id": "155", "items": 1, "rules": [{"processed_products": 64, "products": 64, "rule_id": "1"}], "started_at": "2016-05-18T15:16:25+00:00", "user_id": "1"}, {"applied_to_all_items": false, "duration": 1.464, "finished_at": "2016-05-18T15:17:22+00:00", "id": "156", "items": 1, "rules": [{"processed_products": 64, "products": 64, "rule_id": "1"}, {"processed_products": 64, "products": 64, "rule_id": "5"}], "started_at": "2016-05-18T15:17:21+00:00", "user_id": null}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"example": {"data": [{"applied_to_all_items": true, "duration": 1.548, "finished_at": "2016-05-18T15:16:26+00:00", "id": "155", "items": 1, "rules": [{"processed_products": 64, "products": 64, "rule_id": "1"}], "started_at": "2016-05-18T15:16:25+00:00", "user_id": "1"}, {"applied_to_all_items": false, "duration": 1.464, "finished_at": "2016-05-18T15:17:22+00:00", "id": "156", "items": 1, "rules": [{"processed_products": 64, "products": 64, "rule_id": "1"}, {"processed_products": 64, "products": 64, "rule_id": "5"}], "started_at": "2016-05-18T15:17:21+00:00", "user_id": null}], "limit": 10, "offset": 0, "total_results": 2}, "properties": {"data": {"items": {"properties": {"applied_to_all_items": {"type": "boolean"}, "duration": {"type": "number"}, "finished_at": {"type": "string"}, "id": {"type": "string"}, "items": {"type": "number"}, "rules": {"items": {"properties": {"processed_products": {"type": "number"}, "products": {"type": "number"}, "rule_id": {"type": "string"}}, "required": ["processed_products", "products", "rule_id"], "type": "object"}, "type": "array"}, "started_at": {"type": "string"}, "user_id": {"nullable": true, "type": "string"}}, "required": ["duration", "finished_at", "id", "items", "started_at", "rules", "user_id", "applied_to_all_items"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Logs"], "description": "Fetches all apply logs for given project.\n\n**OAuth2 Scope:** `project.logs.read`\n\n**GET** `https://api.mergado.com/projects/id/applylogs/`", "summary": "Get Apply Logs"}}, "/projects/{id}/apps/": {"get": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"app_name": "projectappone", "free_until": "2015-01-09", "paid_until": "2016-01-08"}, {"app_name": "projectapptwo", "free_until": "2015-02-24", "paid_until": "2015-03-23"}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"example": {"data": [{"app_name": "projectappone", "free_until": "2015-01-09", "paid_until": "2016-01-08"}, {"app_name": "projectapptwo", "free_until": "2015-02-24", "paid_until": "2015-03-23"}], "limit": 10, "offset": 0, "total_results": 2}, "properties": {"data": {"items": {"properties": {"app_name": {"type": "string"}, "free_until": {"type": "string"}, "paid_until": {"type": "string"}}, "required": ["app_name", "free_until", "paid_until"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Enabled Apps"], "description": "Lists apps enabled for the given project.\n\n**OAuth2 Scope:** `project.apps.read`\n\n**GET** `https://api.mergado.com/projects/id/apps/`", "summary": "List Project Apps"}}, "/projects/{id}/apps/{name}/": {"get": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "Name of an app.", "in": "path", "name": "name", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"app_name": "projectappone", "free_until": "2015-01-09", "paid_until": "2016-01-08"}}}, "schema": {"example": {"app_name": "projectappone", "free_until": "2015-01-09", "paid_until": "2016-01-08"}, "properties": {"app_name": {"type": "string"}, "free_until": {"type": "string"}, "paid_until": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Enabled Apps"], "description": "Fetches an app enabled by the given project.\n\n**OAuth2 Scope:** `project.apps.read`\n\n**GET** `https://api.mergado.com/projects/id/apps/name/`", "summary": "Get Project App"}, "patch": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "Name of an app.", "in": "path", "name": "name", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"app_name": "projectappone", "free_until": "2015-01-09", "paid_until": "2016-04-08"}}}, "schema": {"example": {"app_name": "projectappone", "free_until": "2015-01-09", "paid_until": "2016-04-08"}, "properties": {"app_name": {"type": "string"}, "free_until": {"type": "string"}, "paid_until": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Enabled Apps"], "description": "Updates an app enabled for the given project.\n\n**OAuth2 Scope:** `project.apps.write`\n\n**PATCH** `https://api.mergado.com/projects/id/apps/name/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"paid_until": "2016-04-08"}, "properties": {"paid_until": {"type": "string"}}, "type": "object"}}}}, "summary": "Update Project App"}}, "/projects/{id}/elements/": {"get": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"IMAGE": {"hidden": false, "id": "3", "order": 3, "origin": "output"}, "PARAM": {"children": {"NAME": {"hidden": false, "id": "5", "order": 1, "origin": "output"}, "VAL": {"hidden": false, "id": "6", "order": 2, "origin": "output"}}, "hidden": false, "id": "4", "order": 4, "origin": "output"}, "PRICE": {"hidden": false, "id": "2", "order": 2, "origin": "output"}, "PRODUCT": {"children": {"id": {"hidden": true, "id": "11", "is_attribute": true, "order": 1, "origin": "input"}}, "hidden": true, "id": "1", "is_attribute": false, "order": 1, "origin": "input"}}}}, "schema": {"example": {"IMAGE": {"hidden": false, "id": "3", "order": 3, "origin": "output"}, "PARAM": {"children": {"NAME": {"hidden": false, "id": "5", "order": 1, "origin": "output"}, "VAL": {"hidden": false, "id": "6", "order": 2, "origin": "output"}}, "hidden": false, "id": "4", "order": 4, "origin": "output"}, "PRICE": {"hidden": false, "id": "2", "order": 2, "origin": "output"}, "PRODUCT": {"children": {"id": {"hidden": true, "id": "11", "is_attribute": true, "order": 1, "origin": "input"}}, "hidden": true, "id": "1", "is_attribute": false, "order": 1, "origin": "input"}}, "properties": {"IMAGE": {"properties": {"hidden": {"type": "boolean"}, "id": {"type": "string"}, "order": {"type": "number"}, "origin": {"type": "string"}}, "type": "object"}, "PARAM": {"properties": {"children": {"properties": {"NAME": {"properties": {"hidden": {"type": "boolean"}, "id": {"type": "string"}, "order": {"type": "number"}, "origin": {"type": "string"}}, "type": "object"}, "VAL": {"properties": {"hidden": {"type": "boolean"}, "id": {"type": "string"}, "order": {"type": "number"}, "origin": {"type": "string"}}, "type": "object"}}, "type": "object"}, "hidden": {"type": "boolean"}, "id": {"type": "string"}, "order": {"type": "number"}, "origin": {"type": "string"}}, "type": "object"}, "PRICE": {"properties": {"hidden": {"type": "boolean"}, "id": {"type": "string"}, "order": {"type": "number"}, "origin": {"type": "string"}}, "type": "object"}, "PRODUCT": {"properties": {"children": {"properties": {"id": {"properties": {"hidden": {"type": "boolean"}, "id": {"type": "string"}, "is_attribute": {"type": "boolean"}, "order": {"type": "number"}, "origin": {"type": "string"}}, "type": "object"}}, "type": "object"}, "hidden": {"type": "boolean"}, "id": {"type": "string"}, "is_attribute": {"type": "boolean"}, "order": {"type": "number"}, "origin": {"type": "string"}}, "type": "object"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Elements"], "description": "Lists all project's elements in a tree structure.\n\n**Note:** For MERGADO 1 the response doesn't contain the field `order`.\n\n**OAuth2 Scope:** `project.elements.read`\n\n**GET** `https://api.mergado.com/projects/id/elements/`", "summary": "List Project Elements"}, "post": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": {"hidden": false, "is_attribute": false, "name": "SHIPPING", "order": 3, "origin": "manual", "parent_id": null}}}, "schema": {"example": {"hidden": false, "is_attribute": false, "name": "SHIPPING", "order": 3, "origin": "manual", "parent_id": null}, "properties": {"hidden": {"type": "boolean"}, "is_attribute": {"type": "boolean"}, "name": {"type": "string"}, "order": {"type": "number"}, "origin": {"type": "string"}, "parent_id": {"nullable": true}}, "type": "object"}}}, "description": "Created", "headers": {"Location": {"schema": {"type": "string"}}}}}, "tags": ["Elements"], "description": "Creates an element inside a project.\n\nIn the request, in case of\n\n* not specifying `order`, the element will be created as the last one,\n\n* specifying `order`, the element will be created at the specified spot and the `order` of other elements will be adjusted accordingly,\n\n* not specifying `is_attribute`, it will be set to `false`,\n\n* the element is being created in MERGADO 1, `order` is ignored,\n\n* the element is being created in MERGADO 1 and `is_attribute = true`, 409 will be returned.\n\n**OAuth2 Scope:** `project.elements.write`\n\n**POST** `POSThttps://api.mergado.com/projects/id/elements/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"hidden": false, "name": "SHIPPING"}, "properties": {"hidden": {"type": "boolean"}, "name": {"type": "string"}}, "type": "object"}}}}, "summary": "Create an Element"}}, "/projects/{id}/elements/values": {"get": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"value": "modrá", "count": 5}, {"value": "červená", "count": 4}, {"value": "zelená", "count": 4}, {"value": "bílá", "count": 2}, {"value": "černá", "count": 1}, {"value": "žlutá", "count": 1}], "limit": 10, "total_results": 2, "offset": 0}}}, "schema": {"properties": {"data": {"items": {"properties": {"value": {"type": "string"}, "count": {"type": "number"}}, "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "total_results": {"type": "number"}, "offset": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Elements"], "description": "Returns all values from the project for the element whose element path is specified in the `element_path` URL parameter. The `element_path` parameter is required.\n\nThe `is_output` parameter allows you to filter values ​​based on their occurrence. It supports the following values:\n\n+ `true` – Returns output values.\n\n+ `false` – Returns input values.\n\n+ `null` (or omitted) – Returns output values.\n\n**OAuth2 Scope:** `project.read`\n\n**GET** `https://api.mergado.com/projects/id/elements/values`", "summary": "Element Values - GET"}, "post": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"value": "modrá", "count": 5}, {"value": "červená", "count": 4}, {"value": "zelená", "count": 4}, {"value": "bílá", "count": 2}, {"value": "černá", "count": 1}, {"value": "žlutá", "count": 1}], "limit": 10, "total_results": 2, "offset": 0}}}, "schema": {"type": "object", "properties": {"data": {"type": "array", "items": {"type": "object", "properties": {"value": {"type": "string"}, "count": {"type": "number"}}}}, "limit": {"type": "number"}, "total_results": {"type": "number"}, "offset": {"type": "number"}}}}}, "description": "OK", "headers": {}}}, "tags": ["Elements"], "description": "Returns all values from the project for the element whose element path is specified in the `element_path` field within the request body. The `element_path` parameter is required.\n\nThe `is_output` field within the request body allows you to filter values based on their occurrence. It supports the following values:\n\n+ `true` – Returns output values.\n\n+ `false` – Returns input values.\n\n+ `null` (or omitted) – Returns output values.\n\n**OAuth2 Scope:** `project.read`\n\n**POST** `https://api.mergado.com/projects/id/elements/values`", "summary": "Element Values - POST"}}, "/projects/{id}/exportlogs/": {"get": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"duration": 5, "finished_at": null, "id": "1", "initial": false, "items": 20, "processed_items": 20, "started_at": "2016-06-01T15:52:45+00:00", "user_id": "1"}, {"duration": 10, "finished_at": "2016-06-01T15:54:44+00:00", "id": "2", "initial": false, "items": 100, "processed_items": 100, "started_at": "2016-06-01T15:54:30+00:00", "user_id": "1"}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"example": {"data": [{"duration": 5, "finished_at": null, "id": "1", "initial": false, "items": 20, "processed_items": 20, "started_at": "2016-06-01T15:52:45+00:00", "user_id": "1"}, {"duration": 10, "finished_at": "2016-06-01T15:54:44+00:00", "id": "2", "initial": false, "items": 100, "processed_items": 100, "started_at": "2016-06-01T15:54:30+00:00", "user_id": "1"}], "limit": 10, "offset": 0, "total_results": 2}, "properties": {"data": {"items": {"properties": {"duration": {"type": "number"}, "finished_at": {"nullable": true, "type": "string"}, "id": {"type": "string"}, "initial": {"type": "boolean"}, "items": {"type": "number"}, "processed_items": {"type": "number"}, "started_at": {"type": "string"}, "user_id": {"type": "string"}}, "required": ["duration", "finished_at", "id", "initial", "items", "processed_items", "started_at", "user_id"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Logs"], "description": "Fetches all export logs for given project.\n\n**OAuth2 Scope:** `project.logs.read`\n\n**GET** `https://api.mergado.com/projects/id/exportlogs/`", "summary": "Get Export Logs"}}, "/projects/{id}/feedaudits/": {"get": {"parameters": [{"description": "ID of the project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"encoding": "utf-8", "error": null, "feed_types": ["heureka.cz", "zbozi.cz"], "feed_url": "https://www.example.com/feed.xml", "finished_at": null, "id": "51768ba7ed14f444772d6137", "parser_type": "heureka.cz", "product_count": 8367, "progress": 40, "shop_name": "Example.com", "started_at": "2013-04-23T13:24:55+00:00", "status": "in_progress", "time": 254, "webhook_url": "http://www.example.com/ping.php"}], "limit": 10, "offset": 0, "total_results": 1}}}, "schema": {"example": {"data": [{"encoding": "utf-8", "error": null, "feed_types": ["heureka.cz", "zbozi.cz"], "feed_url": "https://www.example.com/feed.xml", "finished_at": null, "id": "51768ba7ed14f444772d6137", "parser_type": "heureka.cz", "product_count": 8367, "progress": 40, "shop_name": "Example.com", "started_at": "2013-04-23T13:24:55+00:00", "status": "in_progress", "time": 254, "webhook_url": "http://www.example.com/ping.php"}], "limit": 10, "offset": 0, "total_results": 1}, "properties": {"data": {"items": {"properties": {"encoding": {"type": "string"}, "error": {"nullable": true}, "feed_types": {"items": {"type": "string"}, "type": "array"}, "feed_url": {"type": "string"}, "finished_at": {"nullable": true}, "id": {"type": "string"}, "parser_type": {"type": "string"}, "product_count": {"type": "number"}, "progress": {"type": "number"}, "shop_name": {"type": "string"}, "started_at": {"type": "string"}, "status": {"type": "string"}, "time": {"type": "number"}, "webhook_url": {"type": "string"}}, "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Feed Audits"], "description": "Returns list of all audits. **GET** `https://api.mergado.com/projects/id/feedaudits/`", "summary": "List Audits"}, "post": {"parameters": [{"description": "ID of the project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": {"encoding": "utf-8", "error": null, "expired_at": null, "feed_types": ["heureka.cz"], "feed_url": "https://www.example.com/feed.xml", "finished_at": null, "id": "51768ba7ed14f444772d6137", "parser_type": "heureka.cz", "product_count": 8367, "progress": 40, "shop_name": "Example.com", "started_at": "2013-04-23T13:24:55+00:00", "status": "in_progress", "time": 254, "webhook_url": "http://www.example.com/ping.php"}}}, "schema": {"example": {"encoding": "utf-8", "error": null, "expired_at": null, "feed_types": ["heureka.cz"], "feed_url": "https://www.example.com/feed.xml", "finished_at": null, "id": "51768ba7ed14f444772d6137", "parser_type": "heureka.cz", "product_count": 8367, "progress": 40, "shop_name": "Example.com", "started_at": "2013-04-23T13:24:55+00:00", "status": "in_progress", "time": 254, "webhook_url": "http://www.example.com/ping.php"}, "properties": {"encoding": {"type": "string"}, "error": {"nullable": true}, "expired_at": {"nullable": true}, "feed_types": {"items": {"type": "string"}, "type": "array"}, "feed_url": {"type": "string"}, "finished_at": {"nullable": true}, "id": {"type": "string"}, "parser_type": {"type": "string"}, "product_count": {"type": "number"}, "progress": {"type": "number"}, "shop_name": {"type": "string"}, "started_at": {"type": "string"}, "status": {"type": "string"}, "time": {"type": "number"}, "webhook_url": {"type": "string"}}, "type": "object"}}}, "description": "Created", "headers": {"Location": {"schema": {"type": "string"}}}}}, "tags": ["Feed Audits"], "description": "Creates and starts an audit. Feed type, web hook and shop id are optional.\n\n**OAuth2 Scope:** `projects.feedaudit.write`\n\n**POST** `https://api.mergado.com/projects/id/feedaudits/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"feed_types": ["heureka.cz"], "feed_url": "https://www.example.com/feed.xml", "parser_type": "heureka.cz", "webhook_url": "http://www.example.com/ping.php"}, "properties": {"feed_types": {"items": {"type": "string"}, "type": "array"}, "feed_url": {"type": "string"}, "parser_type": {"type": "string"}, "webhook_url": {"type": "string"}}, "type": "object"}}}}, "summary": "Create a New Audit"}}, "/projects/{id}/google/analytics_4/": {"get": {"parameters": [{"description": "ID of the project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "The general category of the source, for example,\norganic search (organic), cost-per-click paid search (cpc), web referral (referral).\n", "in": "query", "name": "medium", "required": false, "schema": {"type": "string"}}, {"description": "Comma separated list of metrics to use.", "in": "query", "name": "metrics", "required": false, "schema": {"enum": ["sales_sum", "orders_sum", "clicks_sum"], "type": "string"}}, {"description": "Comma separated list of dimensions to use.", "in": "query", "name": "dimensions", "required": false, "schema": {"default": "date", "enum": ["date", "day_of_week"], "type": "string"}}, {"description": "", "in": "query", "name": "start_date", "required": false, "schema": {"type": "string"}}, {"description": "", "in": "query", "name": "end_date", "required": false, "schema": {"type": "string"}}, {"description": "", "in": "query", "name": "fields", "required": false, "schema": {"type": "string"}}, {"description": "", "in": "query", "name": "limit", "required": false, "schema": {"type": "number"}}, {"description": "", "in": "query", "name": "offset", "required": false, "schema": {"type": "number"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"clicks_sum": 861, "group": {"date": "2016-05-04"}, "orders_sum": 50, "sales_sum": 129852}, {"clicks_sum": 1661, "group": {"date": "2016-05-03"}, "orders_sum": 69, "sales_sum": 225298}, {"clicks_sum": 1523, "group": {"date": "2016-05-02"}, "orders_sum": 70, "sales_sum": 141676}, {"clicks_sum": 1095, "group": {"date": "2016-05-01"}, "orders_sum": 54, "sales_sum": 113470}], "limit": 10, "offset": 0, "total_results": 4}}}, "schema": {"example": {"data": [{"clicks_sum": 861, "group": {"date": "2016-05-04"}, "orders_sum": 50, "sales_sum": 129852}, {"clicks_sum": 1661, "group": {"date": "2016-05-03"}, "orders_sum": 69, "sales_sum": 225298}, {"clicks_sum": 1523, "group": {"date": "2016-05-02"}, "orders_sum": 70, "sales_sum": 141676}, {"clicks_sum": 1095, "group": {"date": "2016-05-01"}, "orders_sum": 54, "sales_sum": 113470}], "limit": 10, "offset": 0, "total_results": 4}, "properties": {"data": {"items": {"properties": {"clicks_sum": {"type": "number"}, "group": {"properties": {"date": {"type": "string"}}, "type": "object"}, "orders_sum": {"type": "number"}, "sales_sum": {"type": "number"}}, "required": ["group", "clicks_sum", "orders_sum", "sales_sum"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Google Analytics 4"], "description": "Returns evaluated metrics for each *group* (default is `date`, see bellow) ordered by the *group*'s\nvalue in ascending order. Groups of results can be created using `dimensions` query string.\nIf user didn't set the UTM parameters (or the params are empty),\nmedium is empty and source is set to a regex based on [this](https://gist.github.com/MichalJanik/721d23bd6036b9f67526b1e5305f3a5c)\nmapping (where the key corresponds to Project output format).\n\n**OAuth2 Scope:** `project.ga.read`\n\n**GET** `https://api.mergado.com/projects/id/google/analytics_4/?medium=&metrics=&dimensions=date&start_date=&end_date=&fields=&limit=&offset=`", "summary": "Project Data"}}, "/projects/{id}/importlogs/": {"get": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"duration": 2.352, "finished_at": "2016-05-18T15:16:25+00:00", "id": "75", "items": 1, "items_created": 1, "items_processed": 1, "items_removed": 0, "items_updated": 0, "started_at": "2016-05-18T15:16:23+00:00", "user_id": "1"}, {"duration": 1.423, "finished_at": "2016-05-18T15:17:21+00:00", "id": "76", "items": 1, "items_created": 0, "items_processed": 1, "items_removed": 0, "items_updated": 0, "started_at": "2016-05-18T15:17:20+00:00", "user_id": null}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"example": {"data": [{"duration": 2.352, "finished_at": "2016-05-18T15:16:25+00:00", "id": "75", "items": 1, "items_created": 1, "items_processed": 1, "items_removed": 0, "items_updated": 0, "started_at": "2016-05-18T15:16:23+00:00", "user_id": "1"}, {"duration": 1.423, "finished_at": "2016-05-18T15:17:21+00:00", "id": "76", "items": 1, "items_created": 0, "items_processed": 1, "items_removed": 0, "items_updated": 0, "started_at": "2016-05-18T15:17:20+00:00", "user_id": null}], "limit": 10, "offset": 0, "total_results": 2}, "properties": {"data": {"items": {"properties": {"duration": {"type": "number"}, "finished_at": {"type": "string"}, "id": {"type": "string"}, "items": {"type": "number"}, "items_created": {"type": "number"}, "items_processed": {"type": "number"}, "items_removed": {"type": "number"}, "items_updated": {"type": "number"}, "started_at": {"type": "string"}, "user_id": {"nullable": true, "type": "string"}}, "required": ["duration", "finished_at", "id", "items", "items_created", "items_processed", "items_removed", "items_updated", "started_at", "user_id"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Logs"], "description": "Fetches all import logs for given project.\n\n**OAuth2 Scope:** `project.logs.read`\n\n**GET** `https://api.mergado.com/projects/id/importlogs/`", "summary": "Get Import Logs"}}, "/projects/{id}/info/": {"get": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"*/*": {"schema": {"properties": {"metadata": {"description": "Specific data for the project that were entered by the user or loaded from an input feed. For example:", "properties": {"generator": {"description": "Application which generated the input feed.", "type": "string"}, "stats_ga_medium": {"description": "Google Analytics `ga:medium` parameter. The advertising or marketing medium, for example: cpc, banner, email newsletter.", "type": "string"}, "stats_ga_source": {"description": "Google Analytics `ga:source` parameter. Identify the advertiser, site, publication, etc. that is sending traffic to your property, for example: google, newsletter4, billboard.", "type": "string"}}, "type": "object"}, "number_of_elements": {"description": "Number of elements in the project.", "type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Projects"], "description": "**Warning:** Deprecated, will be removed after 30. 7. 2019\n\nShow additional project information and statistics.\nReturns the metadata that the user has set or none if user didn't set them.\nSupports regular format as well as custom format mapping.\n\n**Oauth2 Scope:** `project.elements.read`\n\n**GET** `https://api.mergado.com/projects/id/info/`\n\n**Attributes:** \n * **number_of_elements (number):** Number of elements in the project. \n\n * **metadata (object):** \n \n ---", "summary": "Show Project Info"}}, "/projects/{id}/pairings/": {"get": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"id": "1693", "created_at": "2016-04-28T17:18:50+00:00", "deleted_at": "2019-03-27T17:18:45+00:00"}, {"id": "1694", "created_at": "2016-04-28T17:18:50+00:00", "deleted_at": null}], "limit": 10, "total_results": 2, "offset": 0}}}, "schema": {"properties": {"data": {"items": {"properties": {"id": {"type": "string"}, "created_at": {"type": "string"}, "deleted_at": {"nullable": true, "type": "string"}}, "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "total_results": {"type": "number"}, "offset": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Pairings"], "description": "Returns project's pairings.\n\n**OAuth2 Scope:** `project.products.read`\n\n**GET** `https://api.mergado.com/projects/id/pairings/`", "summary": "List Pairings"}}, "/projects/{id}/products": {"get": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"data": {"attributes": {"TOP_LEVEL_ATTRIBUTE": {"value": "123"}}, "elements": {"IMAGE": [{"value": "img 1"}, {"value": "img 2"}, {"value": "img 3"}], "ITEM_ID": [{"attributes": {"id": "456"}, "input_value": "123", "value": "123"}], "PARAM": [{"elements": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Černá"}]}}, {"elements": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Modrá"}]}, "value": "value of PARAM"}], "PRICE": [{"input_value": 69, "value": 69}]}}, "extracted_values": {"ITEM_ID": ["123"], "PARAM | VAL": ["Černá", "Modrá"], "Variable": ["value_from_variable"]}, "id": "1693", "output_changed_at": null, "updated_at": "2016-04-28T17:18:50+00:00"}], "limit": 10, "offset": 0, "total_results": 1}}}, "schema": {"example": {"data": [{"data": {"attributes": {"TOP_LEVEL_ATTRIBUTE": {"value": "123"}}, "elements": {"IMAGE": [{"value": "img 1"}, {"value": "img 2"}, {"value": "img 3"}], "ITEM_ID": [{"attributes": {"id": "456"}, "input_value": "123", "value": "123"}], "PARAM": [{"elements": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Černá"}]}}, {"elements": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Modrá"}]}, "value": "value of PARAM"}], "PRICE": [{"input_value": 69, "value": 69}]}}, "extracted_values": {"ITEM_ID": ["123"], "PARAM | VAL": ["Černá", "Modrá"], "Variable": ["value_from_variable"]}, "id": "1693", "output_changed_at": null, "updated_at": "2016-04-28T17:18:50+00:00"}], "limit": 10, "offset": 0, "total_results": 1}, "properties": {"data": {"items": {"properties": {"data": {"properties": {"attributes": {"properties": {"TOP_LEVEL_ATTRIBUTE": {"properties": {"value": {"type": "string"}}, "type": "object"}}, "type": "object"}, "elements": {"properties": {"IMAGE": {"items": {"properties": {"value": {"type": "string"}}, "required": ["value"], "type": "object"}, "type": "array"}, "ITEM_ID": {"items": {"properties": {"attributes": {"properties": {"id": {"type": "string"}}, "type": "object"}, "input_value": {"type": "string"}, "value": {"type": "string"}}, "type": "object"}, "type": "array"}, "PARAM": {"items": {"properties": {"elements": {"properties": {"NAME": {"items": {"properties": {"value": {"type": "string"}}, "required": ["value"], "type": "object"}, "type": "array"}, "VAL": {"items": {"properties": {"value": {"type": "string"}}, "required": ["value"], "type": "object"}, "type": "array"}}, "type": "object"}, "value": {"type": "string"}}, "required": ["elements"], "type": "object"}, "type": "array"}, "PRICE": {"items": {"properties": {"input_value": {"type": "number"}, "value": {"type": "number"}}, "type": "object"}, "type": "array"}}, "type": "object"}}, "type": "object"}, "extracted_values": {"properties": {"ITEM_ID": {"items": {"type": "string"}, "type": "array"}, "PARAM | VAL": {"items": {"type": "string"}, "type": "array"}, "Variable": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "id": {"type": "string"}, "output_changed_at": {"nullable": true}, "updated_at": {"type": "string"}}, "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Products"], "description": "**OAuth2 Scope:** `project.products.read`.**GET** `https://api.mergado.com/projects/id/products`", "summary": "List Project Products - GET"}, "post": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"data": {"attributes": {"TOP_LEVEL_ATTRIBUTE": {"value": "123"}}, "elements": {"IMAGE": [{"value": "img 1"}, {"value": "img 2"}, {"value": "img 3"}], "ITEM_ID": [{"attributes": {"id": "456"}, "input_value": "123", "value": "123"}], "PARAM": [{"elements": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Černá"}]}}, {"elements": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Modrá"}]}, "value": "value of PARAM"}], "PRICE": [{"input_value": 69, "value": 69}]}}, "extracted_values": {"ITEM_ID": ["123"], "PARAM | VAL": ["Černá", "Modrá"], "Variable": ["value_from_variable"]}, "id": "1693", "output_changed_at": null, "updated_at": "2016-04-28T17:18:50+00:00"}], "limit": 10, "offset": 0, "total_results": 1}}}, "schema": {"example": {"data": [{"data": {"attributes": {"TOP_LEVEL_ATTRIBUTE": {"value": "123"}}, "elements": {"IMAGE": [{"value": "img 1"}, {"value": "img 2"}, {"value": "img 3"}], "ITEM_ID": [{"attributes": {"id": "456"}, "input_value": "123", "value": "123"}], "PARAM": [{"elements": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Černá"}]}}, {"elements": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Modrá"}]}, "value": "value of PARAM"}], "PRICE": [{"input_value": 69, "value": 69}]}}, "extracted_values": {"ITEM_ID": ["123"], "PARAM | VAL": ["Černá", "Modrá"], "Variable": ["value_from_variable"]}, "id": "1693", "output_changed_at": null, "updated_at": "2016-04-28T17:18:50+00:00"}], "limit": 10, "offset": 0, "total_results": 1}, "properties": {"data": {"items": {"properties": {"data": {"properties": {"attributes": {"properties": {"TOP_LEVEL_ATTRIBUTE": {"properties": {"value": {"type": "string"}}, "type": "object"}}, "type": "object"}, "elements": {"properties": {"IMAGE": {"items": {"properties": {"value": {"type": "string"}}, "required": ["value"], "type": "object"}, "type": "array"}, "ITEM_ID": {"items": {"properties": {"attributes": {"properties": {"id": {"type": "string"}}, "type": "object"}, "input_value": {"type": "string"}, "value": {"type": "string"}}, "type": "object"}, "type": "array"}, "PARAM": {"items": {"properties": {"elements": {"properties": {"NAME": {"items": {"properties": {"value": {"type": "string"}}, "required": ["value"], "type": "object"}, "type": "array"}, "VAL": {"items": {"properties": {"value": {"type": "string"}}, "required": ["value"], "type": "object"}, "type": "array"}}, "type": "object"}, "value": {"type": "string"}}, "required": ["elements"], "type": "object"}, "type": "array"}, "PRICE": {"items": {"properties": {"input_value": {"type": "number"}, "value": {"type": "number"}}, "type": "object"}, "type": "array"}}, "type": "object"}}, "type": "object"}, "extracted_values": {"properties": {"ITEM_ID": {"items": {"type": "string"}, "type": "array"}, "PARAM | VAL": {"items": {"type": "string"}, "type": "array"}, "Variable": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "id": {"type": "string"}, "output_changed_at": {"nullable": true}, "updated_at": {"type": "string"}}, "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Products"], "description": "**OAuth2 Scope:** `project.products.read`. **POST** `https://api.mergado.com/projects/id/products`", "requestBody": {"content": {"application/json": {"schema": {"example": {"mql": "ITEM_ID = 123"}, "properties": {"mql": {"type": "string"}}, "type": "object"}}}}, "summary": "List Project Products - POST"}}, "/projects/{id}/queries/": {"get": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"advanced_interface": false, "created_at": "2016-03-22T09:05:14+00:00", "id": "2", "name": null, "product_count": 986, "project_id": "33", "query": "CATEGORYTEXT = \"Spotřební materiál | Pásky a filmy\"", "read_only": false, "search_output": false}, {"advanced_interface": false, "created_at": "2016-03-22T09:02:42+00:00", "id": "1", "name": "ALLPRODUCTS", "product_count": 74, "project_id": "33", "query": "", "read_only": true, "search_output": false}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"example": {"data": [{"advanced_interface": false, "created_at": "2016-03-22T09:05:14+00:00", "id": "2", "name": null, "product_count": 986, "project_id": "33", "query": "CATEGORYTEXT = \"Spotřební materiál | Pásky a filmy\"", "read_only": false, "search_output": false}, {"advanced_interface": false, "created_at": "2016-03-22T09:02:42+00:00", "id": "1", "name": "ALLPRODUCTS", "product_count": 74, "project_id": "33", "query": "", "read_only": true, "search_output": false}], "limit": 10, "offset": 0, "total_results": 2}, "properties": {"data": {"items": {"properties": {"advanced_interface": {"type": "boolean"}, "created_at": {"type": "string"}, "id": {"type": "string"}, "name": {"nullable": true, "type": "string"}, "product_count": {"type": "number"}, "project_id": {"type": "string"}, "query": {"type": "string"}, "read_only": {"type": "boolean"}, "search_output": {"type": "boolean"}}, "required": ["id", "name", "project_id", "advanced_interface", "created_at", "query", "read_only", "search_output", "product_count"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Queries"], "description": "Lists all queries that were created inside the specified project.\n\n**OAuth2 Scope:** `project.queries.read`\n\n\n**GET** `https://api.mergado.com/projects/id/queries/`", "summary": "List Project Queries"}, "post": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": {"advanced_interface": true, "created_at": "2016-03-22T09:02:42+00:00", "id": "d3o9v", "name": "PRICE less then 200 Kč", "product_count": 206, "project_id": "21", "query": "PRICE < 200", "read_only": false, "search_output": false}}}, "schema": {"example": {"advanced_interface": true, "created_at": "2016-03-22T09:02:42+00:00", "id": "d3o9v", "name": "PRICE less then 200 Kč", "product_count": 206, "project_id": "21", "query": "PRICE < 200", "read_only": false, "search_output": false}, "properties": {"advanced_interface": {"type": "boolean"}, "created_at": {"type": "string"}, "id": {"type": "string"}, "name": {"type": "string"}, "product_count": {"type": "number"}, "project_id": {"type": "string"}, "query": {"type": "string"}, "read_only": {"type": "boolean"}, "search_output": {"type": "boolean"}}, "type": "object"}}}, "description": "Created", "headers": {"Location": {"schema": {"type": "string"}}}}}, "tags": ["Queries"], "description": "Creates a new query inside the specified project.\n\n**OAuth2 Scope:** `project.queries.write`\n\n**POST** `https://api.mergado.com/projects/id/queries/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"name": "PRICE less then 200 Kčget rule d", "query": "PRICE < 200", "read_only": false, "search_output": true}, "properties": {"name": {"type": "string"}, "query": {"type": "string"}, "read_only": {"type": "boolean"}, "search_output": {"type": "boolean"}}, "type": "object"}}}}, "summary": "Create a Query"}}, "/projects/{id}/rules/": {"get": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"applies": true, "element_path": "DESCRIPTION", "id": "1", "is_deletable": true, "is_editable": true, "is_movable": true, "is_pausable": true, "name": null, "priority": "0", "project_id": "1", "type": "format_converter"}, {"applies": true, "element_path": "PRICE", "id": "15", "is_deletable": true, "is_editable": true, "is_movable": true, "is_pausable": true, "name": "Cena", "priority": "3", "project_id": "1", "type": "batch_rewriting"}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"example": {"data": [{"applies": true, "element_path": "DESCRIPTION", "id": "1", "is_deletable": true, "is_editable": true, "is_movable": true, "is_pausable": true, "name": null, "priority": "0", "project_id": "1", "type": "format_converter"}, {"applies": true, "element_path": "PRICE", "id": "15", "is_deletable": true, "is_editable": true, "is_movable": true, "is_pausable": true, "name": "Cena", "priority": "3", "project_id": "1", "type": "batch_rewriting"}], "limit": 10, "offset": 0, "total_results": 2}, "properties": {"data": {"items": {"properties": {"applies": {"type": "boolean"}, "element_path": {"type": "string"}, "id": {"type": "string"}, "is_deletable": {"type": "boolean"}, "is_editable": {"type": "boolean"}, "is_movable": {"type": "boolean"}, "is_pausable": {"type": "boolean"}, "name": {"nullable": true, "type": "string"}, "priority": {"type": "string"}, "project_id": {"type": "string"}, "type": {"type": "string"}}, "required": ["id", "project_id", "element_path", "applies", "is_deletable", "is_movable", "is_editable", "is_pausable", "name", "priority", "type"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Rules"], "description": "Lists all rules' instances that were created inside the specified project.\n\n**OAuth2 Scope:** `project.rules.read`\n\n**GET** `https://api.mergado.com/projects/id/rules/`", "summary": "List Project Rules"}, "post": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": {"applies": true, "data": [{"position": 1, "query_id": "4", "value": "2.00"}, {"position": 2, "query_id": "3", "value": "1.00"}], "element_path": "PRICE", "id": "39", "is_deletable": true, "is_editable": true, "is_movable": true, "is_pausable": true, "name": "Cena 2 BATCH", "priority": "3", "project_id": "33", "queries": [{"advanced_interface": false, "created_at": "2016-03-22T09:02:42+00:00", "id": "1", "name": "♥ALLPRODUCTS♥", "project_id": "33", "query": "", "read_only": true, "search_output": false}], "type": "batch_rewriting"}}}, "schema": {"example": {"applies": true, "data": [{"position": 1, "query_id": "4", "value": "2.00"}, {"position": 2, "query_id": "3", "value": "1.00"}], "element_path": "PRICE", "id": "39", "is_deletable": true, "is_editable": true, "is_movable": true, "is_pausable": true, "name": "Cena 2 BATCH", "priority": "3", "project_id": "33", "queries": [{"advanced_interface": false, "created_at": "2016-03-22T09:02:42+00:00", "id": "1", "name": "♥ALLPRODUCTS♥", "project_id": "33", "query": "", "read_only": true, "search_output": false}], "type": "batch_rewriting"}, "properties": {"applies": {"type": "boolean"}, "data": {"items": {"properties": {"position": {"type": "number"}, "query_id": {"type": "string"}, "value": {"type": "string"}}, "required": ["position", "query_id", "value"], "type": "object"}, "type": "array"}, "element_path": {"type": "string"}, "id": {"type": "string"}, "is_deletable": {"type": "boolean"}, "is_editable": {"type": "boolean"}, "is_movable": {"type": "boolean"}, "is_pausable": {"type": "boolean"}, "name": {"type": "string"}, "priority": {"type": "string"}, "project_id": {"type": "string"}, "queries": {"items": {"properties": {"advanced_interface": {"type": "boolean"}, "created_at": {"type": "string"}, "id": {"type": "string"}, "name": {"type": "string"}, "project_id": {"type": "string"}, "query": {"type": "string"}, "read_only": {"type": "boolean"}, "search_output": {"type": "boolean"}}, "type": "object"}, "type": "array"}, "type": {"type": "string"}}, "type": "object"}}}, "description": "Created", "headers": {"Location": {"schema": {"type": "string"}}}}}, "tags": ["Rules"], "description": "Creates a new rule inside the specified project. A list of query ids must be supplied. It can contain a single element, such as id of the ♥ALLPRODUCTS♥ query.\n\nThere are two ways how to specify priority. You can either use the *placement* parameter and specify\nthe id of the rule that the newly created one is supposed to **follow** or **precede**.\nOr you can set the *priority* value directly. Parameters *priority* and *placement* are optional, but at least\none of them must be specified.\n\nNote that if there already is a rule with the given priority, the priority of the new rule will be adjusted\nso that the new rule follows the one with conflicting priority. Also note that *placement* is only regarded\nwhen a rule is created or updated. Another rule may be placed between the created rule and the one it was originally\nplaced before / after later on.\n\nTo determine the priority on server side, we first check the value of *placement[after]*,\nthen the value of *placement [before]* and lastly the value of *priority* itself.\n\n**Note:** The maximum length of the attribute `name` is 100 characters and cannot contain any special characters.\n\n**OAuth2 Scope:** `project.rules.write`\n\n**POST** `https://api.mergado.com/projects/id/rules/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"applies": true, "data": [{"position": 1, "query_id": "4", "value": "2.00"}, {"position": 2, "query_id": "3", "value": "1.00"}], "deletable": true, "element_path": "PRICE", "name": "Cena 2 BATCH", "priority": "3", "type": "batch_rewriting"}, "properties": {"applies": {"type": "boolean"}, "data": {"items": {"properties": {"position": {"type": "number"}, "query_id": {"type": "string"}, "value": {"type": "string"}}, "required": ["position", "query_id", "value"], "type": "object"}, "type": "array"}, "deletable": {"type": "boolean"}, "element_path": {"type": "string"}, "name": {"type": "string"}, "priority": {"type": "string"}, "type": {"type": "string"}}, "type": "object"}}}}, "summary": "Create a Rule"}}, "/projects/{id}/stats/categories/": {"get": {"parameters": [{"description": "ID of the project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"categorytext": "Elektronika | Foto | Foto doplňky a příslušenství | Fotopapíry", "date": "2016-04-19", "paired_products": 5, "unpaired_products": 0}, {"categorytext": "Elektronika | Foto | Dalekohledy", "date": "2016-04-19", "paired_products": 20, "unpaired_products": 10}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"example": {"data": [{"categorytext": "Elektronika | Foto | Foto doplňky a příslušenství | Fotopapíry", "date": "2016-04-19", "paired_products": 5, "unpaired_products": 0}, {"categorytext": "Elektronika | Foto | Dalekohledy", "date": "2016-04-19", "paired_products": 20, "unpaired_products": 10}], "limit": 10, "offset": 0, "total_results": 2}, "properties": {"data": {"items": {"properties": {"categorytext": {"type": "string"}, "date": {"type": "string"}, "paired_products": {"type": "number"}, "unpaired_products": {"type": "number"}}, "required": ["categorytext", "date", "paired_products", "unpaired_products"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Statistics"], "description": "Returns latest statistics of feed's categories (for example number of paired products\nfor given `CATEGORYTEXT`).\n\n**OAuth2 Scope:** `shop.stats.read`\n\n**GET** `https://api.mergado.com/projects/id/stats/categories/`", "summary": "Statistics of Categories"}}, "/projects/{id}/stats/products/": {"parameters": [{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "ID projektu"}], "get": {"parameters": [{"description": "ID of the project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "Date of the collection of the requested statistics.", "in": "query", "name": "date", "required": false, "schema": {"type": "string"}}, {"description": "Currently only filtering by `item id` is supported.\nSee the section [Additional GET parameters](#introduction/requests/additional-get-parameters)\n", "in": "query", "name": "filter_by", "required": false, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"after": "1000", "data": [{"date": "2018-08-08", "product_id": "2550458", "stats": {"heureka_actual_cpc": 1.5, "heureka_card_name": "TFA 30.5027.02", "heureka_category": "Měřiče teploty a vlhkosti", "heureka_categorytext": "Zvlhčovače vzduchu", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 0, "heureka_feed_cpc": 12.65, "heureka_id": "123", "heureka_imgurl": "https://www.example.cz/eshop/data/1001/img/vlhkoměr_TFA.jpg", "heureka_manufacturer": "TFA", "heureka_max_prices": [350, 350, 350, 350, 350, 350], "heureka_min_cpc": 1.5, "heureka_min_price": 350, "heureka_min_prices": [350, 350, 350, 350, 350, 350], "heureka_name": "Teploměr s vlhkoměrem TFA 30.5027.02", "heureka_popularity": 53, "heureka_price_position": 1, "heureka_price_vat": 350, "heureka_sales": 0, "heureka_segment": "Stavebniny", "heureka_shop_url": "https://www.example.cz/eshop/teplomer-s-vlhkomerem-tfa-30-5027-02.html", "heureka_shops_count": 6, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://merice-teploty-vlhkosti.heureka.cz/tfa-30_5027_02", "item_id": "1001"}}, {"date": "2018-08-08", "product_id": "2550461", "stats": {"heureka_actual_cpc": 1.5, "heureka_avg_position": 2.4, "heureka_card_name": "Lanaform Living LA120602", "heureka_category": "Čističky vzduchu a zvlhčovače", "heureka_categorytext": "Heureka.cz | Bílé zboží | Klima | Čističky vzduchu a zvlhčovače", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 2, "heureka_feed_cpc": 18.88, "heureka_id": "124", "heureka_imgurl": "https://www.example.cz/eshop/data/1002/img/zvlhčovač_living.jpg", "heureka_manufacturer": "Lanaform", "heureka_max_prices": [2790, 3090, 3090, 3190, 3950], "heureka_min_cpc": 4.5, "heureka_min_price": 2790, "heureka_min_prices": [2790, 3090, 3090, 3190, 3950], "heureka_name": "Lanaform Living LA120602", "heureka_popularity": 6, "heureka_price_position": 4, "heureka_price_vat": 3190, "heureka_sales": 0, "heureka_segment": "Bílé zboží", "heureka_shop_url": "https://www.example.cz/eshop/zvlhcovac-vzduchu-lanaform-living.html", "heureka_shops_count": 5, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://cisticky-vzduchu-a-zvlhcovace.heureka.cz/lanaform-living-la120602", "item_id": "1002"}}], "limit": 10, "offset": 0}}}, "schema": {"example": {"after": "1000", "data": [{"date": "2018-08-08", "product_id": "2550458", "stats": {"heureka_actual_cpc": 1.5, "heureka_card_name": "TFA 30.5027.02", "heureka_category": "Měřiče teploty a vlhkosti", "heureka_categorytext": "Zvlhčovače vzduchu", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 0, "heureka_feed_cpc": 12.65, "heureka_id": "123", "heureka_imgurl": "https://www.example.cz/eshop/data/1001/img/vlhkoměr_TFA.jpg", "heureka_manufacturer": "TFA", "heureka_max_prices": [350, 350, 350, 350, 350, 350], "heureka_min_cpc": 1.5, "heureka_min_price": 350, "heureka_min_prices": [350, 350, 350, 350, 350, 350], "heureka_name": "Teploměr s vlhkoměrem TFA 30.5027.02", "heureka_popularity": 53, "heureka_price_position": 1, "heureka_price_vat": 350, "heureka_sales": 0, "heureka_segment": "Stavebniny", "heureka_shop_url": "https://www.example.cz/eshop/teplomer-s-vlhkomerem-tfa-30-5027-02.html", "heureka_shops_count": 6, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://merice-teploty-vlhkosti.heureka.cz/tfa-30_5027_02", "item_id": "1001"}}, {"date": "2018-08-08", "product_id": "2550461", "stats": {"heureka_actual_cpc": 1.5, "heureka_avg_position": 2.4, "heureka_card_name": "Lanaform Living LA120602", "heureka_category": "Čističky vzduchu a zvlhčovače", "heureka_categorytext": "Heureka.cz | Bílé zboží | Klima | Čističky vzduchu a zvlhčovače", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 2, "heureka_feed_cpc": 18.88, "heureka_id": "124", "heureka_imgurl": "https://www.example.cz/eshop/data/1002/img/zvlhčovač_living.jpg", "heureka_manufacturer": "Lanaform", "heureka_max_prices": [2790, 3090, 3090, 3190, 3950], "heureka_min_cpc": 4.5, "heureka_min_price": 2790, "heureka_min_prices": [2790, 3090, 3090, 3190, 3950], "heureka_name": "Lanaform Living LA120602", "heureka_popularity": 6, "heureka_price_position": 4, "heureka_price_vat": 3190, "heureka_sales": 0, "heureka_segment": "Bílé zboží", "heureka_shop_url": "https://www.example.cz/eshop/zvlhcovac-vzduchu-lanaform-living.html", "heureka_shops_count": 5, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://cisticky-vzduchu-a-zvlhcovace.heureka.cz/lanaform-living-la120602", "item_id": "1002"}}], "limit": 10, "offset": 0}, "properties": {"after": {"type": "string"}, "data": {"items": {"properties": {"date": {"type": "string"}, "product_id": {"type": "string"}, "stats": {"properties": {"heureka_actual_cpc": {"type": "number"}, "heureka_avg_position": {"type": "number"}, "heureka_card_name": {"type": "string"}, "heureka_category": {"type": "string"}, "heureka_categorytext": {"type": "string"}, "heureka_clicks": {"type": "number"}, "heureka_cost_of_sales": {"type": "number"}, "heureka_cpc": {"type": "number"}, "heureka_delivery_date": {"type": "number"}, "heureka_feed_cpc": {"type": "number"}, "heureka_id": {"type": "string"}, "heureka_imgurl": {"type": "string"}, "heureka_manufacturer": {"type": "string"}, "heureka_max_prices": {"items": {"type": "number"}, "type": "array"}, "heureka_min_cpc": {"type": "number"}, "heureka_min_price": {"type": "number"}, "heureka_min_prices": {"items": {"type": "number"}, "type": "array"}, "heureka_name": {"type": "string"}, "heureka_popularity": {"type": "number"}, "heureka_price_position": {"type": "number"}, "heureka_price_vat": {"type": "number"}, "heureka_sales": {"type": "number"}, "heureka_segment": {"type": "string"}, "heureka_shop_url": {"type": "string"}, "heureka_shops_count": {"type": "number"}, "heureka_total_cost": {"type": "number"}, "heureka_total_orders": {"type": "number"}, "heureka_url": {"type": "string"}, "item_id": {"type": "string"}}, "type": "object"}}, "required": ["date", "stats", "product_id"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Statistics"], "description": "Returns statistics of all products associated with the project.\nBy default, only the latest statistics (usualy from yesterday)\nare returned. This can be changed by the query string parameter `date`. Only the stats\nrelevant to the project format are returned. Note that `product_id` is not returned if mapping from `item_id` to\n`product_id` failed.\n`after` can be used instead of offset. The value of `after` should be\n`item_id` of the last product from the previous batch.\nThe reason for using `after` is that high offset (> 10k)\ncauses request timeouts on Elastic's side.\nIf `filter_by` contains `_exists_` parameter (with json list of *stats* fields as the param value),\nonly the products that have those fields defined will be returned.\nFor example: `filter_by={\"_exists_\":[\"heureka_cpc\", \"item_id\"]}`\n\n**OAuth2 Scope:** `project.stats.read`\n\n**GET** `https://api.mergado.com/projects/id/stats/products/?date=&filter_by=`", "summary": "Statistics of All Project Products"}, "post": {"responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"date": "2018-08-08", "product_id": "2550458", "stats": {"heureka_actual_cpc": 1.5, "heureka_card_name": "TFA 30.5027.02", "heureka_category": "Měřiče teploty a vlhkosti", "heureka_categorytext": "Zvlhčovače vzduchu", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 0, "heureka_feed_cpc": 12.65, "heureka_id": "123", "heureka_imgurl": "https://www.example.cz/eshop/data/1001/img/vlhkoměr_TFA.jpg", "heureka_manufacturer": "TFA", "heureka_max_prices": [350, 350, 350, 350, 350, 350], "heureka_min_cpc": 1.5, "heureka_min_price": 350, "heureka_min_prices": [350, 350, 350, 350, 350, 350], "heureka_name": "Teploměr s vlhkoměrem TFA 30.5027.02", "heureka_popularity": 53, "heureka_price_position": 1, "heureka_price_vat": 350, "heureka_sales": 0, "heureka_segment": "Stavebniny", "heureka_shop_url": "https://www.example.cz/eshop/teplomer-s-vlhkomerem-tfa-30-5027-02.html", "heureka_shops_count": 6, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://merice-teploty-vlhkosti.heureka.cz/tfa-30_5027_02", "item_id": "1001"}}, {"date": "2018-08-08", "product_id": "2550461", "stats": {"heureka_actual_cpc": 1.5, "heureka_avg_position": 2.4, "heureka_card_name": "Lanaform Living LA120602", "heureka_category": "Čističky vzduchu a zvlhčovače", "heureka_categorytext": "Heureka.cz | Bílé zboží | Klima | Čističky vzduchu a zvlhčovače", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 2, "heureka_feed_cpc": 18.88, "heureka_id": "124", "heureka_imgurl": "https://www.example.cz/eshop/data/1002/img/zvlhčovač_living.jpg", "heureka_manufacturer": "Lanaform", "heureka_max_prices": [2790, 3090, 3090, 3190, 3950], "heureka_min_cpc": 4.5, "heureka_min_price": 2790, "heureka_min_prices": [2790, 3090, 3090, 3190, 3950], "heureka_name": "Lanaform Living LA120602", "heureka_popularity": 6, "heureka_price_position": 4, "heureka_price_vat": 3190, "heureka_sales": 0, "heureka_segment": "Bílé zboží", "heureka_shop_url": "https://www.example.cz/eshop/zvlhcovac-vzduchu-lanaform-living.html", "heureka_shops_count": 5, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://cisticky-vzduchu-a-zvlhcovace.heureka.cz/lanaform-living-la120602", "item_id": "1002"}}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"example": {"data": [{"date": "2018-08-08", "product_id": "2550458", "stats": {"heureka_actual_cpc": 1.5, "heureka_card_name": "TFA 30.5027.02", "heureka_category": "Měřiče teploty a vlhkosti", "heureka_categorytext": "Zvlhčovače vzduchu", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 0, "heureka_feed_cpc": 12.65, "heureka_id": "123", "heureka_imgurl": "https://www.example.cz/eshop/data/1001/img/vlhkoměr_TFA.jpg", "heureka_manufacturer": "TFA", "heureka_max_prices": [350, 350, 350, 350, 350, 350], "heureka_min_cpc": 1.5, "heureka_min_price": 350, "heureka_min_prices": [350, 350, 350, 350, 350, 350], "heureka_name": "Teploměr s vlhkoměrem TFA 30.5027.02", "heureka_popularity": 53, "heureka_price_position": 1, "heureka_price_vat": 350, "heureka_sales": 0, "heureka_segment": "Stavebniny", "heureka_shop_url": "https://www.example.cz/eshop/teplomer-s-vlhkomerem-tfa-30-5027-02.html", "heureka_shops_count": 6, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://merice-teploty-vlhkosti.heureka.cz/tfa-30_5027_02", "item_id": "1001"}}, {"date": "2018-08-08", "product_id": "2550461", "stats": {"heureka_actual_cpc": 1.5, "heureka_avg_position": 2.4, "heureka_card_name": "Lanaform Living LA120602", "heureka_category": "Čističky vzduchu a zvlhčovače", "heureka_categorytext": "Heureka.cz | Bílé zboží | Klima | Čističky vzduchu a zvlhčovače", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 2, "heureka_feed_cpc": 18.88, "heureka_id": "124", "heureka_imgurl": "https://www.example.cz/eshop/data/1002/img/zvlhčovač_living.jpg", "heureka_manufacturer": "Lanaform", "heureka_max_prices": [2790, 3090, 3090, 3190, 3950], "heureka_min_cpc": 4.5, "heureka_min_price": 2790, "heureka_min_prices": [2790, 3090, 3090, 3190, 3950], "heureka_name": "Lanaform Living LA120602", "heureka_popularity": 6, "heureka_price_position": 4, "heureka_price_vat": 3190, "heureka_sales": 0, "heureka_segment": "Bílé zboží", "heureka_shop_url": "https://www.example.cz/eshop/zvlhcovac-vzduchu-lanaform-living.html", "heureka_shops_count": 5, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://cisticky-vzduchu-a-zvlhcovace.heureka.cz/lanaform-living-la120602", "item_id": "1002"}}], "limit": 10, "offset": 0, "total_results": 2}, "properties": {"data": {"items": {"properties": {"date": {"type": "string"}, "product_id": {"type": "string"}, "stats": {"properties": {"heureka_actual_cpc": {"type": "number"}, "heureka_avg_position": {"type": "number"}, "heureka_card_name": {"type": "string"}, "heureka_category": {"type": "string"}, "heureka_categorytext": {"type": "string"}, "heureka_clicks": {"type": "number"}, "heureka_cost_of_sales": {"type": "number"}, "heureka_cpc": {"type": "number"}, "heureka_delivery_date": {"type": "number"}, "heureka_feed_cpc": {"type": "number"}, "heureka_id": {"type": "string"}, "heureka_imgurl": {"type": "string"}, "heureka_manufacturer": {"type": "string"}, "heureka_max_prices": {"items": {"type": "number"}, "type": "array"}, "heureka_min_cpc": {"type": "number"}, "heureka_min_price": {"type": "number"}, "heureka_min_prices": {"items": {"type": "number"}, "type": "array"}, "heureka_name": {"type": "string"}, "heureka_popularity": {"type": "number"}, "heureka_price_position": {"type": "number"}, "heureka_price_vat": {"type": "number"}, "heureka_sales": {"type": "number"}, "heureka_segment": {"type": "string"}, "heureka_shop_url": {"type": "string"}, "heureka_shops_count": {"type": "number"}, "heureka_total_cost": {"type": "number"}, "heureka_total_orders": {"type": "number"}, "heureka_url": {"type": "string"}, "item_id": {"type": "string"}}, "type": "object"}}, "required": ["date", "stats", "product_id"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Statistics"], "description": "Returns statistics of all products associated with the project.\nBy default, only the latest statistics (usualy from yesterday)\nare returned. This can be changed by the query string parameter `date`. Only the stats\nrelevant to the project format are returned. Note that `product_id` is not returned if mapping from `item_id` to\n`product_id` failed.\n`after` can be used instead of offset. The value of `after` should be\n`item_id` of the last product from the previous batch.\nThe reason for using `after` is that high offset (> 10k)\ncauses request timeouts on Elastic's side.\nIf `filter_by` contains `_exists_` parameter (with json list of *stats* fields as the param value),\nonly the products that have those fields defined will be returned.\nFor example: `filter_by={\"_exists_\":[\"heureka_cpc\", \"item_id\"]}`\n\n**OAuth2 Scope:** `project.stats.read`\n\n**POST** `https://api.mergado.com/projects/id/stats/products/`\n\n**Attributes:** \n\n * **date (string):** Date of the collection of the requested statistics. \n\n * **filter_by (string):** Currently only filtering by item_id is supported. See the section Additional GET parameters. \n\n ---", "requestBody": {"content": {"application/json": {"schema": {"example": {"date": "2016-02-02", "filter_by": {"item_id__in": ["a", "b", "c"]}}, "properties": {"date": {"description": "Date of the collection of the requested statistics.", "type": "string"}, "filter_by": {"description": "Currently only filtering by `item id` is supported.\n\nSee the section [Additional GET parameters](#introduction/requests/additional-get-parameters).", "type": "string"}}, "type": "object"}}}}, "summary": "Statistics of All Project Products using POST"}}, "/projects/{id}/variables/": {"get": {"parameters": [{"description": "ID of a variable.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"element_path": "DESCRIPTION", "fragment_number": 2, "id": "1521", "name": "DESCRIPTION_A", "project_id": "33", "regular_expression": "(\\-|\\* )?(.*)", "sample_text": null, "type": "manual"}], "limit": 10, "offset": 0, "total_results": 1}}}, "schema": {"example": {"data": [{"element_path": "DESCRIPTION", "fragment_number": 2, "id": "1521", "name": "DESCRIPTION_A", "project_id": "33", "regular_expression": "(\\-|\\* )?(.*)", "sample_text": null, "type": "manual"}], "limit": 10, "offset": 0, "total_results": 1}, "properties": {"data": {"items": {"properties": {"element_path": {"type": "string"}, "fragment_number": {"type": "number"}, "id": {"type": "string"}, "name": {"type": "string"}, "project_id": {"type": "string"}, "regular_expression": {"type": "string"}, "sample_text": {"nullable": true}, "type": {"type": "string"}}, "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Variables"], "description": "Lists all project's variables.\n\n**OAuth2 Scope:** `project.variables.read`\n\n**GET** `https://api.mergado.com/projects/id/variables/`", "summary": "List Project Variables"}}, "/queries/{id}/": {"delete": {"parameters": [{"description": "ID of a query.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content", "headers": {}}}, "tags": ["Queries"], "description": "Deletes a specific query.\n\n**OAuth2 Scope:** `project.queries.write`\n\n\n**DELETE** `https://api.mergado.com/queries/id/`", "summary": "Delete a Query"}, "get": {"parameters": [{"description": "ID of a query.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"advanced_interface": false, "created_at": "2016-03-22T09:05:14+00:00", "id": "2", "name": null, "product_count": 12, "project_id": "33", "query": "CATEGORYTEXT = \"Spotřební materiál | Ostatní spotřební materiál | Pásky a filmy\"", "read_only": false, "search_output": false}}}, "schema": {"example": {"advanced_interface": false, "created_at": "2016-03-22T09:05:14+00:00", "id": "2", "name": null, "product_count": 12, "project_id": "33", "query": "CATEGORYTEXT = \"Spotřební materiál | Ostatní spotřební materiál | Pásky a filmy\"", "read_only": false, "search_output": false}, "properties": {"advanced_interface": {"type": "boolean"}, "created_at": {"type": "string"}, "id": {"type": "string"}, "name": {"nullable": true}, "product_count": {"type": "number"}, "project_id": {"type": "string"}, "query": {"type": "string"}, "read_only": {"type": "boolean"}, "search_output": {"type": "boolean"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Queries"], "description": "Returns the requrested query.\n\n**OAuth2 Scope:** `project.queries.read`\n\n**GET** `https://api.mergado.com/queries/id/`", "summary": "Get a Query"}, "patch": {"parameters": [{"description": "ID of a project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"advanced_interface": false, "created_at": "2016-03-22T09:02:42+00:00", "id": "d3o9v", "name": "PRICE more then 200 Kč", "product_count": 12983, "project_id": "21", "query": "PRICE > 200", "read_only": false, "search_output": false}}}, "schema": {"example": {"advanced_interface": false, "created_at": "2016-03-22T09:02:42+00:00", "id": "d3o9v", "name": "PRICE more then 200 Kč", "product_count": 12983, "project_id": "21", "query": "PRICE > 200", "read_only": false, "search_output": false}, "properties": {"advanced_interface": {"type": "boolean"}, "created_at": {"type": "string"}, "id": {"type": "string"}, "name": {"type": "string"}, "product_count": {"type": "number"}, "project_id": {"type": "string"}, "query": {"type": "string"}, "read_only": {"type": "boolean"}, "search_output": {"type": "boolean"}}, "type": "object"}}}, "description": "OK", "headers": {"Location": {"schema": {"type": "string"}}}}}, "tags": ["Queries"], "description": "Performes update of the specified query.\n\n**OAuth2 Scope:** `project.queries.write`\n\n**PATCH** `https://api.mergado.com/queries/id/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"query": "PRICE > 200"}, "properties": {"query": {"type": "string"}}, "type": "object"}}}}, "summary": "Update a Query"}}, "/queries/{id}/products/": {"get": {"parameters": [{"description": "ID of the query.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"data": {"IMAGE": [{"value": "img 1"}, {"value": "img 2"}, {"value": "img 2"}], "ITEM_ID": [{"attributes": {"some-shit": "uff"}, "input_value": "ab", "value": "ab"}], "PARAM": [{"children": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Hnusná"}]}}, {"children": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Hnusná"}]}, "value": "some val"}], "PRICE": [{"input_value": 69, "value": 69}]}, "id": "3838", "output_changed_at": "2016-04-25T17:20:44+00:00", "updated_at": "2016-04-25T16:42:50+00:00"}, {"data": {"IMAGE": [{"value": "img 1"}, {"value": "img 2"}, {"value": "img 2"}], "ITEM_ID": [{"attributes": {"some-shit": "uff"}, "input_value": "ab", "value": "ab"}], "PARAM": [{"children": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Hnusná"}]}}, {"children": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Hnusná"}]}, "value": "some val"}], "PRICE": [{"input_value": 69, "value": 69}]}, "id": "3839", "output_changed_at": "2016-04-25T17:20:44+00:00", "updated_at": "2016-04-25T16:42:50+00:00"}], "limit": 10, "offset": 0, "total_results": 1}}}, "schema": {"example": {"data": [{"data": {"IMAGE": [{"value": "img 1"}, {"value": "img 2"}, {"value": "img 2"}], "ITEM_ID": [{"attributes": {"some-shit": "uff"}, "input_value": "ab", "value": "ab"}], "PARAM": [{"children": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Hnusná"}]}}, {"children": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Hnusná"}]}, "value": "some val"}], "PRICE": [{"input_value": 69, "value": 69}]}, "id": "3838", "output_changed_at": "2016-04-25T17:20:44+00:00", "updated_at": "2016-04-25T16:42:50+00:00"}, {"data": {"IMAGE": [{"value": "img 1"}, {"value": "img 2"}, {"value": "img 2"}], "ITEM_ID": [{"attributes": {"some-shit": "uff"}, "input_value": "ab", "value": "ab"}], "PARAM": [{"children": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Hnusná"}]}}, {"children": {"NAME": [{"value": "Barva"}], "VAL": [{"value": "Hnusná"}]}, "value": "some val"}], "PRICE": [{"input_value": 69, "value": 69}]}, "id": "3839", "output_changed_at": "2016-04-25T17:20:44+00:00", "updated_at": "2016-04-25T16:42:50+00:00"}], "limit": 10, "offset": 0, "total_results": 1}, "properties": {"data": {"items": {"properties": {"data": {"properties": {"IMAGE": {"items": {"properties": {"value": {"type": "string"}}, "required": ["value"], "type": "object"}, "type": "array"}, "ITEM_ID": {"items": {"properties": {"attributes": {"properties": {"some-shit": {"type": "string"}}, "type": "object"}, "input_value": {"type": "string"}, "value": {"type": "string"}}, "required": ["input_value", "value", "attributes"], "type": "object"}, "type": "array"}, "PARAM": {"items": {"properties": {"children": {"properties": {"NAME": {"items": {"properties": {"value": {"type": "string"}}, "required": ["value"], "type": "object"}, "type": "array"}, "VAL": {"items": {"properties": {"value": {"type": "string"}}, "required": ["value"], "type": "object"}, "type": "array"}}, "type": "object"}, "value": {"type": "string"}}, "required": ["children", "value"], "type": "object"}, "type": "array"}, "PRICE": {"items": {"properties": {"input_value": {"type": "number"}, "value": {"type": "number"}}, "required": ["input_value", "value"], "type": "object"}, "type": "array"}}, "type": "object"}, "id": {"type": "string"}, "output_changed_at": {"type": "string"}, "updated_at": {"type": "string"}}, "required": ["id", "output_changed_at", "updated_at", "data"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Products"], "description": "Returns products that satisfy a condition defined by the given query.\n\nIf the `values_to_extract` parameter is provided,\nthe response will automatically include a field called `extracted_values`,\ncontaining data extracted from the specified element paths or variable. If parameter\nis missing, `extracted_values` field will not be included in endpoint reponse.\n\nThe `is_hidden` parameter allows filtering products based on their visibility status. It supports the following values:\n\n+ `true` – Returns only hidden products.\n\n+ `false` – Returns only non-hidden products.\n\n+ `null` (or omitted) – Returns all products, regardless of their visibility.\n\n**OAuth2 Scope:** `projects.products.read`\n\n**GET** `https://api.mergado.com/queries/id/products/` ", "summary": "Query Products"}, "patch": {"parameters": [{"description": "ID of a product.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content", "headers": {}}}, "tags": ["Products"], "description": "Updates products matching a query.\n\n**Note:** Currently, it is possible tu update only the field `is_dirty` which can be used\nto force Mergado to refresh the products (apply rules) during the next (lazy) rebuild.\n\nFor optimization reasons, nothing is returned in the response, and whether the products have\nhas already been applied can be checked in the logs at `/projects//applylogs/`.\nNevertheless, it is acceptable to mark the product as dirty without prior checking to see if it is even necessary.\n\n**OAuth2 Scope:** `project.products.write`\n\n**PATCH** `https://api.mergado.com/queries/id/products/` ", "requestBody": {"content": {"application/json": {"schema": {"example": {"is_dirty": true}, "properties": {"is_dirty": {"type": "boolean"}}, "type": "object"}}}}, "summary": "Update queried products"}}, "/rules/definitions/": {"get": {"responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"fields": [], "relationship": "1:1", "type": "format_converter"}, {"fields": [{"name": "new_content", "required": true, "type": "STRING"}], "relationship": "1:1", "type": "rewriting"}, {"fields": [{"name": "search", "required": true, "type": "STRING"}, {"name": "replacement", "required": true, "type": "STRING"}, {"name": "regex", "required": true, "type": "BOOLEAN"}, {"name": "case_sensitive", "required": true, "type": "BOOLEAN"}], "relationship": "1:1", "type": "replacing"}], "limit": 10, "offset": 0, "total_results": 3}}}, "schema": {"example": {"data": [{"fields": [], "relationship": "1:1", "type": "format_converter"}, {"fields": [{"name": "new_content", "type": "STRING"}], "relationship": "1:1", "type": "rewriting"}, {"fields": [{"name": "search", "type": "STRING"}, {"name": "replacement", "type": "STRING"}, {"name": "regex", "type": "BOOLEAN"}, {"name": "case_sensitive", "type": "BOOLEAN"}], "relationship": "1:1", "type": "replacing"}], "limit": 10, "offset": 0, "total_results": 3}, "properties": {"data": {"items": {"properties": {"fields": {"items": {"properties": {"name": {"type": "string"}, "required": {"type": "boolean"}, "type": {"type": "string"}}, "required": ["name", "required", "type"], "type": "object"}, "type": "array"}, "relationship": {"type": "string"}, "type": {"type": "string"}}, "required": ["type", "relationship", "fields"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Base"], "description": "Returns definitions of all rules and required data for their instantiation. **GET** `https://api.mergado.com/rules/definitions/`", "summary": "List Defined Rules"}}, "/rules/{id}/": {"delete": {"parameters": [{"description": "ID of a rule.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content", "headers": {}}}, "tags": ["Rules"], "description": "Delete the specified rule.\n\n**OAuth2 Scope:** `project.rules.write`\n\n\n**DELETE** `https://api.mergado.com/rules/id/`", "summary": "Delete a Rule"}, "get": {"parameters": [{"description": "ID of a rule.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"applies": true, "data": {"new_content": "%CATEGORYTEXT%"}, "element_path": "DESCRIPTION", "id": "15", "is_deletable": true, "is_editable": true, "is_movable": true, "is_pausable": true, "name": "Cena", "priority": "3", "project_id": "1", "type": "rewriting"}}}, "schema": {"example": {"applies": true, "data": {"new_content": "%CATEGORYTEXT%"}, "element_path": "DESCRIPTION", "id": "15", "is_deletable": true, "is_editable": true, "is_movable": true, "is_pausable": true, "name": "Cena", "priority": "3", "project_id": "1", "type": "rewriting"}, "properties": {"applies": {"type": "boolean"}, "data": {"properties": {"new_content": {"type": "string"}}, "type": "object"}, "element_path": {"type": "string"}, "id": {"type": "string"}, "is_deletable": {"type": "boolean"}, "is_editable": {"type": "boolean"}, "is_movable": {"type": "boolean"}, "is_pausable": {"type": "boolean"}, "name": {"type": "string"}, "priority": {"type": "string"}, "project_id": {"type": "string"}, "type": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Rules"], "description": "Returns a specific rule instance.\n\n**OAuth2 Scope:** `project.rules.read`\n\n\n**GET** `https://api.mergado.com/rules/id/`", "summary": "Get a Rule"}, "patch": {"parameters": [{"description": "ID of a rule.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "headers": {"Location": {"schema": {"type": "string"}}}, "content": {"application/json": {"examples": {"response": {"value": {"id": "112", "project_id": "2", "element_path": "DESCRIPTION", "applies": true, "is_deletable": true, "is_movable": true, "is_editable": true, "is_pausable": true, "name": "PRODUCTNAME: Added Free Car", "placement": {"before": "111"}, "type": "rewriting", "data": {"new_content": "%CATEGORYTEXT% + Car"}}}}, "schema": {"type": "object", "properties": {"id": {"type": "string"}, "project_id": {"type": "string"}, "element_path": {"type": "string"}, "applies": {"type": "boolean"}, "is_deletable": {"type": "boolean"}, "is_movable": {"type": "boolean"}, "is_editable": {"type": "boolean"}, "is_pausable": {"type": "boolean"}, "name": {"type": "string"}, "placement": {"type": "object", "properties": {"before": {"type": "string"}}}, "type": {"type": "string"}, "data": {"type": "object", "properties": {"new_content": {"type": "string"}}}}}}}}}, "tags": ["Rules"], "description": "Performs update of rule's attributes. Refer to the doc for rule creation to find out more about\nhow priority is calculated. If no queries are present in the request, the queries will not be changed.\nIf an empty list is sent, 400 will be returned.\n\n**Note:** The maximum length of the attribute `name` is 100 characters and cannot contain any special characters.\n\n**OAuth2 Scope:** `project.rules.write`\n\n**PATCH** `https://api.mergado.com/rules/id/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"data": {"new_content": "%PRODUCTNAME% + Car"}, "name": "PRODUCTNAME: Added Free Car"}, "properties": {"data": {"properties": {"new_content": {"type": "string"}}, "type": "object"}, "name": {"type": "string"}}, "type": "object"}}}}, "summary": "Update a Rule"}}, "/rules/{id}/data/": {"get": {"parameters": [{"description": "ID of a rule.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"position": 1, "query_id": "28", "value": "2.00"}, {"position": 2, "query_id": "30", "value": "1.00"}], "rule_id": "15", "type": "batch_rewriting"}}}, "schema": {"example": {"data": [{"position": 1, "query_id": "28", "value": "2.00"}, {"position": 2, "query_id": "30", "value": "1.00"}], "rule_id": "15", "type": "batch_rewriting"}, "properties": {"data": {"items": {"properties": {"position": {"type": "number"}, "query_id": {"type": "string"}, "value": {"type": "string"}}, "required": ["position", "query_id", "value"], "type": "object"}, "type": "array"}, "rule_id": {"type": "string"}, "type": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Rules"], "description": "Returns only the data of a specific rule instance. This can be helpful\nfor one to many (O2M) rules with a lot of records.\n\n**OAuth2 Scope:** `project.rules.read`\n\n\n**GET** `https://api.mergado.com/rules/id/data/`", "summary": "Get Rule Data"}}, "/rules/{id}/queries/": {"get": {"parameters": [{"description": "ID of a rule.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"advanced_interface": false, "created_at": "2016-03-22T09:05:14+00:00", "id": "2", "name": null, "product_count": 12, "project_id": "33", "query": "CATEGORYTEXT = \"Spotřební materiál | Pásky a filmy\"", "read_only": false, "search_output": false}, {"advanced_interface": false, "created_at": "2016-03-22T09:02:42+00:00", "id": "1", "name": "ALLPRODUCTS", "product_count": 38, "project_id": "33", "query": "", "read_only": true, "search_output": false}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"example": {"data": [{"advanced_interface": false, "created_at": "2016-03-22T09:05:14+00:00", "id": "2", "name": null, "product_count": 12, "project_id": "33", "query": "CATEGORYTEXT = \"Spotřební materiál | Pásky a filmy\"", "read_only": false, "search_output": false}, {"advanced_interface": false, "created_at": "2016-03-22T09:02:42+00:00", "id": "1", "name": "ALLPRODUCTS", "product_count": 38, "project_id": "33", "query": "", "read_only": true, "search_output": false}], "limit": 10, "offset": 0, "total_results": 2}, "properties": {"data": {"items": {"properties": {"advanced_interface": {"type": "boolean"}, "created_at": {"type": "string"}, "id": {"type": "string"}, "name": {"nullable": true, "type": "string"}, "product_count": {"type": "number"}, "project_id": {"type": "string"}, "query": {"type": "string"}, "read_only": {"type": "boolean"}, "search_output": {"type": "boolean"}}, "required": ["id", "name", "project_id", "advanced_interface", "created_at", "query", "read_only", "search_output", "product_count"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Queries"], "description": "Lists all queries that were created for the specified rule.\n\n**OAuth2 Scope:** `project.queries.read`\n\n**GET** `https://api.mergado.com/rules/id/queries/`", "summary": "List Rule Queries"}, "patch": {"parameters": [{"description": "ID of a rule.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"advanced_interface": false, "created_at": "2016-03-22T09:05:14+00:00", "id": "2", "name": "PRICE more then 200 Kč", "product_count": 4583, "project_id": "33", "query": "PRICE > 200", "read_only": false, "search_output": false}], "limit": 10, "offset": 0, "total_results": 1}}}, "schema": {"example": {"data": [{"advanced_interface": false, "created_at": "2016-03-22T09:05:14+00:00", "id": "2", "name": "PRICE more then 200 Kč", "product_count": 4583, "project_id": "33", "query": "PRICE > 200", "read_only": false, "search_output": false}], "limit": 10, "offset": 0, "total_results": 1}, "properties": {"data": {"items": {"properties": {"advanced_interface": {"type": "boolean"}, "created_at": {"type": "string"}, "id": {"type": "string"}, "name": {"type": "string"}, "product_count": {"type": "number"}, "project_id": {"type": "string"}, "query": {"type": "string"}, "read_only": {"type": "boolean"}, "search_output": {"type": "boolean"}}, "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {"Location": {"schema": {"type": "string"}}}}}, "tags": ["Queries"], "description": "Assigns a Query to a Rule. The query must exist, otherwise 400 (bad request) status is returned.\nThe body parameters also must uniquely identify a query.\n\n**OAuth2 Scope:** `project.rules.write`\n\n**PATCH** `https://api.mergado.com/rules/id/queries/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"id": "d3o9v"}, "properties": {"id": {"type": "string"}}, "type": "object"}}}}, "summary": "Assign a Query to a Rule"}}, "/rules/{rid}/queries/{qid}": {"delete": {"parameters": [{"description": "ID of a rule.", "in": "path", "name": "rid", "required": true, "schema": {"type": "string"}}, {"description": "ID of a query.", "in": "path", "name": "qid", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content", "headers": {}}}, "tags": ["Queries"], "description": "Retract a Query from a Rule.\n\n**OAuth2 Scope:** `project.rules.write`\n\n**DELETE** `https://api.mergado.com/rules/rid/queries/qid`", "summary": "Retract a Query from a Rule"}}, "/shops/{id}/": {"get": {"parameters": [{"description": "ID of a shop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"avatar_url": "https://app.mergado.com/upload/8787f44a7f7da538ded3d7fc8d6bf7f3.png", "created_at": "2015-11-04T12:31:18+00:00", "exported_items": 256, "id": "1", "name": "Example.com", "owner_id": "1", "permissions": [{"role": "reader", "user_id": "2"}], "tariff_id": "7", "tariff_validity": "2015-12-01T10:02:51+00:00", "web": "http://example.com/", "xml_domain": "example.com"}}}, "schema": {"example": {"avatar_url": "https://app.mergado.com/upload/8787f44a7f7da538ded3d7fc8d6bf7f3.png", "created_at": "2015-11-04T12:31:18+00:00", "exported_items": 256, "id": "1", "name": "Example.com", "owner_id": "1", "permissions": [{"role": "reader", "user_id": "2"}], "tariff_id": "7", "tariff_validity": "2015-12-01T10:02:51+00:00", "web": "http://example.com/", "xml_domain": "example.com"}, "properties": {"avatar_url": {"type": "string"}, "created_at": {"type": "string"}, "exported_items": {"type": "number"}, "id": {"type": "string"}, "name": {"type": "string"}, "owner_id": {"type": "string"}, "permissions": {"items": {"properties": {"role": {"type": "string"}, "user_id": {"type": "string"}}, "type": "object"}, "type": "array"}, "tariff_id": {"type": "string"}, "tariff_validity": {"type": "string"}, "web": {"type": "string"}, "xml_domain": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Eshops"], "description": "Returns an eshop with the given ID.\n\n**OAuth2 Scope:** `shop.read`\n\n\n**GET** `https://api.mergado.com/shops/id/` ", "summary": "Get an Eshop"}, "patch": {"parameters": [{"description": "ID of a shop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"avatar_url": "https://app.mergado.com/upload/8787f44a7f7da538ded3d7fc8d6bf7f3.png", "created_at": "2015-11-04T12:31:18+00:00", "exported_items": 256, "id": "1", "name": "Mergado.cz", "owner_id": "1", "permissions": [{"role": "reader", "user_id": "2"}], "tariff_id": "7", "tariff_validity": "2015-12-01T10:02:51+00:00", "web": "http://mergado.cz/", "xml_domain": "mergado.cz"}}}, "schema": {"example": {"avatar_url": "https://app.mergado.com/upload/8787f44a7f7da538ded3d7fc8d6bf7f3.png", "created_at": "2015-11-04T12:31:18+00:00", "exported_items": 256, "id": "1", "name": "Mergado.cz", "owner_id": "1", "permissions": [{"role": "reader", "user_id": "2"}], "tariff_id": "7", "tariff_validity": "2015-12-01T10:02:51+00:00", "web": "http://mergado.cz/", "xml_domain": "mergado.cz"}, "properties": {"avatar_url": {"type": "string"}, "created_at": {"type": "string"}, "exported_items": {"type": "number"}, "id": {"type": "string"}, "name": {"type": "string"}, "owner_id": {"type": "string"}, "permissions": {"items": {"properties": {"role": {"type": "string"}, "user_id": {"type": "string"}}, "type": "object"}, "type": "array"}, "tariff_id": {"type": "string"}, "tariff_validity": {"type": "string"}, "web": {"type": "string"}, "xml_domain": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Eshops"], "description": "Updates an eshop with the given ID.\n\n**OAuth2 Scope:** `shop.write`\n\n**PATCH** `https://api.mergado.com/shops/id/` ", "requestBody": {"content": {"application/json": {"schema": {"example": {"name": "Mergado.cz", "web": "http://mergado.cz/", "xml_domain": "mergado.cz"}, "properties": {"name": {"type": "string"}, "web": {"type": "string"}, "xml_domain": {"type": "string"}}, "type": "object"}}}}, "summary": "Update an Eshop"}}, "/shops/{id}/apps/": {"get": {"parameters": [{"description": "ID of a shop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"app_name": "shopappone", "free_until": "2015-01-09", "paid_until": "2016-01-08"}, {"app_name": "shopapptwo", "free_until": "2015-02-24", "paid_until": "2015-03-23"}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"example": {"data": [{"app_name": "shopappone", "free_until": "2015-01-09", "paid_until": "2016-01-08"}, {"app_name": "shopapptwo", "free_until": "2015-02-24", "paid_until": "2015-03-23"}], "limit": 10, "offset": 0, "total_results": 2}, "properties": {"data": {"items": {"properties": {"app_name": {"type": "string"}, "free_until": {"type": "string"}, "paid_until": {"type": "string"}}, "required": ["app_name", "free_until", "paid_until"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Enabled Apps"], "description": "Lists apps enabled for the given eshop.\n\n**OAuth2 Scope:** `shop.apps.read`\n\n**GET** `https://api.mergado.com/shops/id/apps/`", "summary": "List Shop Apps"}}, "/shops/{id}/apps/{name}/": {"get": {"parameters": [{"description": "ID of a shop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "Name of an app.", "in": "path", "name": "name", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"app_name": "shopappone", "free_until": "2015-01-09", "paid_until": "2016-01-08"}}}, "schema": {"example": {"app_name": "shopappone", "free_until": "2015-01-09", "paid_until": "2016-01-08"}, "properties": {"app_name": {"type": "string"}, "free_until": {"type": "string"}, "paid_until": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Enabled Apps"], "description": "Fetches an app enabled for the given shop.\n\n**OAuth2 Scope:** `shop.apps.read`\n\n**GET** `https://api.mergado.com/shops/id/apps/name/`", "summary": "Get Shop App"}, "patch": {"parameters": [{"description": "ID of a shop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "Name of an app.", "in": "path", "name": "name", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"app_name": "shopappone", "free_until": "2015-01-09", "paid_until": "2017-02-08"}}}, "schema": {"example": {"app_name": "shopappone", "free_until": "2015-01-09", "paid_until": "2017-02-08"}, "properties": {"app_name": {"type": "string"}, "free_until": {"type": "string"}, "paid_until": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Enabled Apps"], "description": "Updates an app enabled for the given shop.\n\n**OAuth2 Scope:** `shop.apps.write`\n\n**PATCH** `https://api.mergado.com/shops/id/apps/name/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"paid_until": "2017-02-08"}, "properties": {"paid_until": {"type": "string"}}, "type": "object"}}}}, "summary": "Update Shop App"}}, "/shops/{id}/eshop-rychle/proxy/{path}": {"parameters": [{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "ID eshopu"}, {"name": "path", "in": "path", "required": true, "schema": {"type": "string"}, "description": "Konkrétní cesta pro Eshop-rychle API"}], "delete": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Eshop-rychle"], "description": "Returns response from Eshop-rychle API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**DELETE** `https://api.mergado.com/shops/id/eshop-rychle/proxy/path`", "summary": "Delete Request"}, "get": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Eshop-rychle"], "description": "Returns response from Eshop-rychle API.\n\n**OAuth2 Scope:** `shop.proxy.read`\n\n**GET** `https://api.mergado.com/shops/id/eshop-rychle/proxy/path`", "summary": "Get Request"}, "post": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Eshop-rychle"], "description": "Returns response from Eshop-rychle API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**POST** `https://api.mergado.com/shops/id/eshop-rychle/proxy/path`", "summary": "Post Request"}, "put": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Eshop-rychle"], "description": "Returns response from Eshop-rychle API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**PUT** `https://api.mergado.com/shops/id/eshop-rychle/proxy/path`", "summary": "Put Request"}}, "/shops/{id}/google/analytics_4/": {"get": {"parameters": [{"description": "ID of the shop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "The source of referrals. For manual campaign tracking,\nit is the value of the utm_source campaign tracking parameter. This parameter is regular expression or ID of a format (see section with formats).\n", "in": "query", "name": "source", "required": false, "schema": {"type": "string"}}, {"description": "The general category of the source, for example,\norganic search (organic), cost-per-click paid search (cpc), web referral (referral).\n", "in": "query", "name": "medium", "required": false, "schema": {"type": "string"}}, {"description": "Comma separated list of metrics to use.", "in": "query", "name": "metrics", "required": false, "schema": {"enum": ["sales_sum", "orders_sum", "clicks_sum"], "type": "string"}}, {"description": "Comma separated list of dimensions to use.", "in": "query", "name": "dimensions", "required": false, "schema": {"default": "date", "enum": ["date", "day_of_week"], "type": "string"}}, {"description": "", "in": "query", "name": "start_date", "required": false, "schema": {"type": "string"}}, {"description": "", "in": "query", "name": "end_date", "required": false, "schema": {"type": "string"}}, {"description": "", "in": "query", "name": "fields", "required": false, "schema": {"type": "string"}}, {"description": "", "in": "query", "name": "limit", "required": false, "schema": {"type": "number"}}, {"description": "", "in": "query", "name": "offset", "required": false, "schema": {"type": "number"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"clicks_sum": 861, "group": {"date": "2016-05-04"}, "orders_sum": 50, "sales_sum": 129852}, {"clicks_sum": 1661, "group": {"date": "2016-05-03"}, "orders_sum": 69, "sales_sum": 225298}, {"clicks_sum": 1523, "group": {"date": "2016-05-02"}, "orders_sum": 70, "sales_sum": 141676}, {"clicks_sum": 1095, "group": {"date": "2016-05-01"}, "orders_sum": 54, "sales_sum": 113470}], "limit": 4, "offset": 0, "total_results": 6}}}, "schema": {"example": {"data": [{"clicks_sum": 861, "group": {"date": "2016-05-04"}, "orders_sum": 50, "sales_sum": 129852}, {"clicks_sum": 1661, "group": {"date": "2016-05-03"}, "orders_sum": 69, "sales_sum": 225298}, {"clicks_sum": 1523, "group": {"date": "2016-05-02"}, "orders_sum": 70, "sales_sum": 141676}, {"clicks_sum": 1095, "group": {"date": "2016-05-01"}, "orders_sum": 54, "sales_sum": 113470}], "limit": 4, "offset": 0, "total_results": 6}, "properties": {"data": {"items": {"properties": {"clicks_sum": {"type": "number"}, "group": {"properties": {"date": {"type": "string"}}, "type": "object"}, "orders_sum": {"type": "number"}, "sales_sum": {"type": "number"}}, "required": ["group", "clicks_sum", "orders_sum", "sales_sum"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Google Analytics 4"], "description": "Returns evaluated metrics for each *group* (default is `date`, see bellow) ordered by the *group*'s\nvalue in ascending order. Groups of results can be created using `dimensions` query string.\nUses only UTM parameters that were sent in the request.\n\n**OAuth2 Scope:** `shop.ga.read`\n\n**GET** `https://api.mergado.com/shops/id/google/analytics_4/?source=&medium=&metrics=&dimensions=date&start_date=&end_date=&fields=&limit=&offset=`", "summary": "Eshop Data"}}, "/shops/{id}/google/analytics_4/proxy": {"post": {"parameters": [{"description": "ID of the eshop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"content": {"dimensionHeaders": [{"name": "date"}], "metricHeaders": [{"name": "sessions", "type": "TYPE_INTEGER"}], "rows": [{"dimensionValues": [{"value": "20221025"}], "metricValues": [{"value": "16"}]}], "rowCount": 1, "metadata": {"currencyCode": "CZK", "timeZone": "Europe/Prague"}, "kind": "analyticsData#runReport"}, "status": 200}}}, "schema": {"type": "object", "properties": {"content": {"type": "object", "properties": {"dimensionHeaders": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}}}}, "metricHeaders": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string"}}}}, "rows": {"type": "array", "items": {"type": "object", "properties": {"dimensionValues": {"type": "array", "items": {"type": "object", "properties": {"value": {"type": "string"}}}}, "metricValues": {"type": "array", "items": {"type": "object", "properties": {"value": {"type": "string"}}}}}}}, "rowCount": {"type": "number"}, "metadata": {"type": "object", "properties": {"currencyCode": {"type": "string"}, "timeZone": {"type": "string"}}}, "kind": {"type": "string"}}}, "status": {"type": "number"}}}}}, "description": "OK", "headers": {}}}, "tags": ["Google Analytics 4"], "description": "Serves as a proxy to Google Analytics Data API.\nParameters sent to Mergado API in request body under `args` are forwarded to Google Analytics Data API as a request to https://analyticsdata.googleapis.com/{version}/{property_name}:{report_method}?alt=json.\nIf `version` parameter is not specified version `v1beta` is used as default. If `report_method` parameter is not specified method `runReport` is used as default.\nThe request is authorized by Mergado using Keychain Credentials (`property_name` in the URL will be replaced with name of the property associated with this credentials).\nResponse content from GA is returned as raw string under `content`.\nResponse code from GA is returned under `status` to allow different codes from Mergado API and GA API.\n\n**OAuth2 Scope:** `shop.ga.read`\n\n**POST** `https://api.mergado.com/shops/id/google/analytics_4/proxy`", "summary": "Google Analytics 4 Data API Proxy"}}, "/shops/{id}/google/merchant/proxy/{path}": {"parameters": [{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "ID of the shop."}, {"name": "path", "in": "path", "required": true, "schema": {"type": "string"}, "description": "Path to forward to the Google Merchant API."}], "get": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Google Merchant"], "description": "Returns response from Google Merchant API.\n\n**OAuth2 Scope:** `shop.proxy.read`\n\n**GET** `https://api.mergado.com/shops/id/google/merchant/proxy/path`", "summary": "Get Request"}, "post": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Google Merchant"], "description": "Returns response from Google Merchant API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**POST** `https://api.mergado.com/shops/id/google/merchant/proxy/path`", "summary": "Post Request"}, "put": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Google Merchant"], "description": "Returns response from Google Merchant API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**PUT** `https://api.mergado.com/shops/id/google/merchant/proxy/path`", "summary": "Put Request"}, "delete": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Google Merchant"], "description": "Returns response from Google Merchant API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**DELETE** `https://api.mergado.com/shops/id/google/merchant/proxy/path`", "summary": "Delete Request"}}, "/shops/{id}/heureka/proxy/{path}": {"parameters": [{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "ID eshopu"}, {"name": "path", "in": "path", "required": true, "schema": {"type": "string"}, "description": "Konkrétní cesta pro Heureka API"}], "delete": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Heureka API Proxy"], "description": "Returns response from Heureka API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**DELETE** `hhttps://api.mergado.com/shops/id/heureka/proxy/path`", "summary": "Delete Request"}, "get": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Heureka API Proxy"], "description": "Returns response from Heureka API.\n\n**OAuth2 Scope:** `shop.proxy.read`\n\n**GET** `https://api.mergado.com/shops/id/heureka/proxy/path`", "summary": "Get Request"}, "post": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Heureka API Proxy"], "description": "Returns response from Heureka API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**POST** `https://api.mergado.com/shops/id/heureka/proxy/path`", "summary": "Post Request"}, "put": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Heureka API Proxy"], "description": "Returns response from Heureka API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**PUT** `https://api.mergado.com/shops/id/heureka/proxy/path`", "summary": "Put Request"}}, "/shops/{id}/info/": {"get": {"parameters": [{"description": "ID of an eshop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"connections": [{"info": {"heureka_id": "12345", "name": "Môj Shop CZ", "url_slug": "moj-shop-cz", "username": "email@example.cz", "api_enabled": true}, "name": "heureka.cz"}, {"info": {"zbozi_id": "54321", "name": "Môj Shop Zbozi", "username": "email@example.cz"}, "name": "zbozi.cz"}, {"info": {"name": "GA4 - Môj Shop", "account_name": "My Account", "property_name": "My Property"}, "name": "google_analytics_4"}, {"info": {"account_id": "12345678"}, "name": "google_merchant"}, {"info": {"api_url": "https://moj-shop.eshop-rychle.cz/api"}, "name": "eshop-rychle.cz"}, {"info": {"orders_feed_url": "https://moj-shop.myshoptet.com/export/orders/"}, "name": "shoptet.cz"}, {"info": {"shopify_url": "https://moj-shop.myshopify.com"}, "name": "shopify.com"}, {"info": {"base_url": "https://moj-shop.sk"}, "name": "woocommerce.com"}, {"info": {"unas_id": "unas-99999"}, "name": "unas.eu"}, {"info": {"sklik_fenix_id": "fenix-77777"}, "name": "sklik_fenix.cz"}], "number_of_projects": 10, "stats_collection": {"info": [{"error": null, "finished_at": "2018-08-09T06:51:40.964592+00:00", "started_at": "2018-08-09T06:50:16.415956+00:00", "status": "done", "type": "mergado.output_feed_heureka"}, {"error": null, "finished_at": "2018-08-09T07:02:38.118057+00:00", "started_at": "2018-08-09T06:50:16.416440+00:00", "status": "done", "type": "mergado.output_feed_zbozi"}, {"error": null, "finished_at": "2018-08-09T07:11:08.220681+00:00", "started_at": "2018-08-09T06:50:16.416785+00:00", "status": "done", "type": "heureka.conversions_feed"}, {"error": null, "finished_at": "2018-08-09T07:16:03.342840+00:00", "started_at": "2018-08-09T06:50:16.417138+00:00", "status": "done", "type": "mergado.costs_feed"}, {"error": null, "finished_at": "2018-08-09T07:56:48.820114+00:00", "started_at": "2018-08-09T06:50:16.418164+00:00", "status": "done", "type": "heureka.sortiment_feed"}, {"error": null, "finished_at": "2018-08-09T07:56:48.901180+00:00", "started_at": "2018-08-09T06:50:16.418496+00:00", "status": "done", "type": "zbozi.product_stats_report"}, {"error": null, "finished_at": "2018-08-09T07:56:48.982153+00:00", "started_at": "2018-08-09T06:50:16.418843+00:00", "status": "done", "type": "mergado.audit"}], "error": null, "finished_at": "2018-08-09T07:56:48.982153+00:00", "started_at": "2018-08-09T06:50:16.415956+00:00", "status": "done"}}}}, "schema": {"properties": {"connections": {"description": "List of objects representing connections to third-party services.", "items": {}, "type": "array"}, "number_of_projects": {"description": "Number of exports (projects) created in this eshop.", "type": "number"}, "stats_collection": {"description": "Information about last collection of statistics.", "properties": {"info": {"items": {}, "type": "array"}, "created_at": {"type": "string"}, "error": {"type": "string"}, "finished_at": {"type": "string"}, "started_at": {"type": "string"}, "status": {"enum": ["done", "in_progress", "error"], "type": "string"}}, "type": "object"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Eshops"], "description": "Show additional eshop information, statistics and keychain connections.\n\n**Oauth2 Scope:** `shop.read`\n\n\n**GET** `https://api.mergado.com/shops/id/info/`\n\n\n\n**Attributes:** \n * **number_of_projects (number):** Number of exports (projects) created in this eshop. \n\n * **stats_collection: object** \n\n * **connections: array** \n\n ---", "summary": "Show Eshop Info"}}, "/shops/{id}/notifications/": {"post": {"parameters": [{"description": "ID of an eshop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"201": {"description": "Created", "content": {"application/json": {"examples": {"response": {"value": {"id": "30", "event": "app_notify", "data": {"title": "Eshop problem", "body": "There seems to be a problem in your eshop."}, "channels": ["email"], "created_at": "2016-05-11T14:43:18+00:00", "priority": "high", "scope": "owner"}}}, "schema": {"type": "object", "properties": {"id": {"type": "string"}, "event": {"type": "string"}, "data": {"type": "object", "properties": {"title": {"type": "string"}, "body": {"type": "string"}}}, "channels": {"type": "array", "items": {"type": "string"}}, "created_at": {"type": "string"}, "priority": {"type": "string"}, "scope": {"type": "string"}}, "example": {"id": "30", "event": "app_notify", "data": {"title": "Eshop problem", "body": "There seems to be a problem in your eshop."}, "channels": ["email"], "created_at": "2016-05-11T14:43:18+00:00", "priority": "high", "scope": "owner"}}}}, "headers": {}}}, "tags": ["Notifications"], "description": "**OAuth2 Scope:** `shop.notify.write`**POST** `https://api.mergado.com/shops/id/notifications/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"body": "There seems to be a problem in your eshop.", "channels": ["email"], "priority": "high", "scope": "owner", "title": "Eshop problem"}, "properties": {"body": {"type": "string"}, "channels": {"items": {"type": "string"}, "type": "array"}, "priority": {"type": "string"}, "scope": {"type": "string"}, "title": {"type": "string"}}, "type": "object"}}}}, "summary": "Notify Eshop Members"}}, "/shops/{id}/projects/": {"get": {"parameters": [{"description": "ID of a shop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"limit": 10, "offset": 0, "total_results": 1, "data": [{"id": "8", "shop_id": "1", "creator_id": "1", "name": "Billiger.de", "url": "https://app.mergado.com/example-com.xml", "created": "2015-11-11T15:42:33+00:00", "exported_items": 0, "input_format": "zbozi.cz", "output_format": "billiger.de", "pairing_elements": "URL", "readonly": false, "is_paused": false, "rules_changed_at": "2015-11-11T15:43:07+00:00", "slug": "example-com-heureka-cz-asdf", "turned_off": true, "update_period": 14400, "last_access": "2015-12-10T12:51:59+00:00", "data_synced_at": "2015-11-18T13:19:59+00:00", "data_updated_at": "2015-11-11T15:42:50+00:00", "is_dirty": false, "in_testing_mode": false, "metadata": {"stats_ga_medium": "agregator", "stats_ga_source": "heureka.*.", "generator": "mergado.magento.marketingpack.0_1"}, "number_of_elements": 28, "all_products_query_id": "1", "sync_schedule": {"minute": "50", "hour": "*/1", "day_of_week": "*", "day_of_month": "*", "month_of_year": "*"}}]}}}, "schema": {"properties": {"limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}, "data": {"items": {"properties": {"id": {"type": "string"}, "shop_id": {"type": "string"}, "creator_id": {"type": "string"}, "name": {"type": "string"}, "url": {"type": "string"}, "created": {"type": "string"}, "exported_items": {"type": "number"}, "input_format": {"type": "string"}, "output_format": {"type": "string"}, "pairing_elements": {"type": "string"}, "readonly": {"type": "boolean"}, "is_paused": {"type": "boolean"}, "rules_changed_at": {"type": "string"}, "slug": {"type": "string"}, "turned_off": {"type": "boolean"}, "update_period": {"type": "number"}, "last_access": {"type": "string"}, "data_synced_at": {"type": "string"}, "data_updated_at": {"type": "string"}, "is_dirty": {"type": "boolean"}, "in_testing_mode": {"type": "boolean"}, "metadata": {"type": "object"}, "number_of_elements": {"type": "number"}, "all_products_query_id": {"type": "string"}, "sync_schedule": {"type": "object"}}, "type": "object"}, "type": "array"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Projects"], "description": "Returns projects of an eshop.\n\n**OAuth2 Scope:** `shop.projects.read`\n\n\n**GET** `https://api.mergado.com/shops/id/projects/` ", "summary": "List Shop Projects"}}, "/shops/{id}/shopify/proxy/{path}": {"parameters": [{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "ID eshopu"}, {"name": "path", "in": "path", "required": true, "schema": {"type": "string"}, "description": "Konkrétní cesta pro Shopify API"}], "delete": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Shopify"], "description": "Returns response from Shopify API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**DELETE** `https://api.mergado.com/shops/id/shopify/proxy/path`", "summary": "Delete Request"}, "get": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Shopify"], "description": "Returns response from Shopify API.\n\n**OAuth2 Scope:** `shop.proxy.read`\n\n**GET** `https://api.mergado.com/shops/id/shopify/proxy/path`", "summary": "Get Request"}, "post": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Shopify"], "description": "Returns response from Shopify API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**POST** `https://api.mergado.com/shops/id/shopify/proxy/path`", "summary": "Post Request"}, "put": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Shopify"], "description": "Returns response from Shopify API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**PUT** `https://api.mergado.com/shops/id/shopify/proxy/path`", "summary": "Put Request"}}, "/shops/{id}/stats/": {"get": {"parameters": [{"description": "ID of the eshop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Statistics"], "description": "Returns latest summarized statistics and other information of an eshop.\n\n**OAuth2 Scope:** `shop.stats.read`\n\n**GET** `https://api.mergado.com/shops/id/stats/`\n\n**Attributes:** \n * **date (string):** Date of collection of the statistics. \n\n * **heureka_contact_email (string):** Contact email of the eshop as shown on Heureka. \n\n * **heureka_contact_phone (string):** Contact phone of the eshop as shown on Heureka. \n\n * **heureka_credit_amount (string):** The amount of credit available in the account under which the eshop is registered. \n\n * **heureka_credit_status (enum):** * **heureka_follows_questions (boolean):** Whether the eshop has signed up to follow questions customers ask on Heureka about a product the eshop offers. \n\n * **heureka_has_certificate (boolean):** Whether the eshop received the certificate called \"Ověřeno zákazníky\" from Heureka. \n\n * **heureka_logo_url (string):** URL of eshop's logo pointed to Heureka's servers. \n\n * **heureka_subsidiaries_count (number):** Number of eshop's subsidiaries registered on Heureka (the eshop may have more subsidiaries, even though that would be their lost). \n\n * **heureka_total_clicks (number):** Total number of clicks during 24 hours (counted for the chosen date) on Heureka for the eshop. \n\n * **heureka_total_cost (number):** (counted for the chosen date) on Heureka for the eshop. \n\n * **heureka_total_orders (number):** Total number of orders during 24 hours (counted for the chosen date) on Heureka for the eshop. \n\n * **heureka_total_sales (number):** (counted for the chosen date) on Heureka for the eshop. \n\n * **heureka_export_url (string):** URL from which Heureka downloads the feed. \n\n * **heureka_xml_available (boolean):** Whether the XML feed Heureka periodically downloads to update eshop's offers was available. \n\n * **heureka_generate_xml_reports (boolean):** Whether eshop administrator enabled to generate XML reports with measurements of conversions on Heureka. \n\n * **heureka_has_active_ppc (boolean):** Whether the eshop runs in the PPC mode on Heureka. \n\n * **heureka_has_free_mode (boolean):** Whether the eshop runs in the free mode on Heureka. \n\n * **heureka_measuring_conversions (boolean):** Whether eshop administrator enabled to collect data from measurements of conversions. \n\n * **heureka_no_delivery_cost_specified (boolean):** Whether eshop administrator specified the cost of delivery on Heureka. \n\n * **heureka_recommend_a_shop (object):** * **heureka_order_status (object):** * **heureka_delivery_time (object):** * **heureka_transportation_type (object):** * **heureka_delivery_point (object):** * **heureka_goods_transportation_quality (number):** Average rating of the goods transportation quality. Contains a number between 0 and 5 (bigger is better). \n\n * **heureka_delivery_point_quality (number):** Average rating of the quality of delivery point. Contains a number between 0 and 5 (bigger is better). \n\n * **heureka_shop_ux_clarity (number):** Average rating of the UX (User eXperience) about the eshop's websites from Heureka users. Contains a number between 0 and 5 (bigger is better). \n\n * **heureka_customer_cancel_order_reason (object):** * **heureka_shop_cancel_order_reason (object):** * **heureka_shop_frequency_of_purchases (object):** * **heureka_last_order_at (string):** The date of last order by any customer. \n\n * **hledejceny_credit_amount (number):** The amount of credit available in the account under which the eshop is registered. \n\n * **hledejceny_total_clicks (number):** Total number of clicks during 24 hours (counted for the chosen date) on Hledejceny for the eshop. \n\n * **hledejceny_total_cost (number):** (counted for the chosen date) on Hledejceny for the eshop. \n\n * **srovname_credit_amount (number):** The amount of credit available in the account under which the eshop is registered. \n\n ---", "requestBody": {"content": {"application/json": {"schema": {"properties": {"date": {"description": "Date of collection of the statistics.", "type": "string"}, "heureka_contact_email": {"description": "Contact email of the eshop as shown\n\non Heureka.", "type": "string"}, "heureka_contact_phone": {"description": "Contact phone of the eshop as shown\n\non Heureka.", "type": "string"}, "heureka_credit_amount": {"description": "The amount of credit available in\n\nthe account under which the eshop is registered.", "type": "string"}, "heureka_credit_status": {"description": "Status of credit on Heureka\n\nevaluated by Mergado.", "enum": ["ok", "low", "none"], "type": "string"}, "heureka_customer_cancel_order_reason": {"description": "Contains answers for question:\n\n\"Why did you cancel your order?\" and number of people which selected the answer.", "properties": {}, "type": "object"}, "heureka_delivery_point": {"description": "Contains answers for question:\n\n\"Which delivery point did you choose to deliver the goods?\" and number of people\nwhich selected the answer.", "properties": {}, "type": "object"}, "heureka_delivery_point_quality": {"description": "Average rating of the quality\n\nof delivery point. Contains a number between 0 and 5 (bigger is better).", "type": "number"}, "heureka_delivery_time": {"description": "Contains answers for question:\n\n\"When did your goods arrive?\" and number of people which selected the answer.", "properties": {}, "type": "object"}, "heureka_export_url": {"description": "URL from which Heureka downloads the feed.", "type": "string"}, "heureka_follows_questions": {"description": "Whether the eshop has signed up\n\nto follow questions customers ask on Heureka about a product the eshop offers.", "type": "boolean"}, "heureka_generate_xml_reports": {"description": "Whether eshop administrator\n\nenabled to generate XML reports with measurements of conversions on Heureka.", "type": "boolean"}, "heureka_goods_transportation_quality": {"description": "Average rating of the\n\ngoods transportation quality. Contains a number between 0 and 5 (bigger is better).", "type": "number"}, "heureka_has_active_ppc": {"description": "Whether the eshop runs in the PPC mode\n\non Heureka.", "type": "boolean"}, "heureka_has_certificate": {"description": "Whether the eshop received the\n\ncertificate called \"Ověřeno zákazníky\" from Heureka.", "type": "boolean"}, "heureka_has_free_mode": {"description": "Whether the eshop runs in the free mode\n\non Heureka.", "type": "boolean"}, "heureka_last_order_at": {"description": "The date of last order by any customer.", "type": "string"}, "heureka_logo_url": {"description": "URL of eshop's logo pointed to Heureka's servers.", "type": "string"}, "heureka_measuring_conversions": {"description": "Whether eshop administrator\n\nenabled to collect data from measurements of conversions.", "type": "boolean"}, "heureka_no_delivery_cost_specified": {"description": "Whether eshop administrator\n\nspecified the cost of delivery on Heureka.", "type": "boolean"}, "heureka_order_status": {"description": "Contains answers for question:\n\n\"In what status if your order?\" and number of people which selected the answer.", "properties": {}, "type": "object"}, "heureka_recommend_a_shop": {"description": "Contains answers for question:\n\n\"Would you recommend this shop?\" and number of people which selected the answer.", "properties": {}, "type": "object"}, "heureka_shop_cancel_order_reason": {"description": "Contains answers for question:\n\n\"Why did shop cancel your order?\" and number of people which selected the answer.", "properties": {}, "type": "object"}, "heureka_shop_frequency_of_purchases": {"description": "Contains answers for question:\n\n\"How many times have you shop in this store?\" and number of people which\nselected the answer.", "properties": {}, "type": "object"}, "heureka_shop_ux_clarity": {"description": "Average rating of the UX (User\n\neXperience) about the eshop's websites from Heureka users. Contains\na number between 0 and 5 (bigger is better).", "type": "number"}, "heureka_subsidiaries_count": {"description": "Number of eshop's subsidiaries\n\nregistered on Heureka (the eshop may have more subsidiaries, even though\nthat would be their lost).", "type": "number"}, "heureka_total_clicks": {"description": "Total number of clicks during 24 hours\n\n(counted for the chosen `date`) on Heureka for the eshop.", "type": "number"}, "heureka_total_cost": {"description": "(counted for the chosen `date`) on Heureka for the eshop.", "type": "number"}, "heureka_total_orders": {"description": "Total number of orders during 24 hours\n\n(counted for the chosen `date`) on Heureka for the eshop.", "type": "number"}, "heureka_total_sales": {"description": "(counted for the chosen `date`) on Heureka for the eshop.", "type": "number"}, "heureka_transportation_type": {"description": "Contains answers for question:\n\n\"Which carrier did you choose to deliver the goods?\" and number of people\nwhich selected the answer.", "properties": {}, "type": "object"}, "heureka_xml_available": {"description": "Whether the XML feed Heureka periodically\n\ndownloads to update eshop's offers was available.", "type": "boolean"}, "hledejceny_credit_amount": {"description": "The amount of credit available in\n\nthe account under which the eshop is registered.", "type": "number"}, "hledejceny_total_clicks": {"description": "Total number of clicks during 24 hours\n\n(counted for the chosen `date`) on Hledejceny for the eshop.", "type": "number"}, "hledejceny_total_cost": {"description": "(counted for the chosen `date`) on Hledejceny for the eshop.", "type": "number"}, "srovname_credit_amount": {"description": "The amount of credit available in\n\nthe account under which the eshop is registered.", "type": "number"}, "srovname_total_clicks": {"description": "Total number of clicks during 24 hours\n\n(counted for the chosen `date`) on Srovname for the eshop.", "type": "number"}, "srovname_total_cost": {"description": "(counted for the chosen `date`) on Srovname for the eshop.", "type": "number"}, "zbozi_credit_amount": {"description": "The amount of credit available in\n\nthe account on Zbozi.cz.", "type": "number"}, "zbozi_credit_amount_with_vat": {"description": "The amount of credit with VAT available in\n\nthe account on Zbozi.cz.", "type": "number"}, "zbozi_is_campaign_activated": {"description": "Whether the campaign is activated\n\non Zbozi.cz, i.e. whether the eshop's products are advertised or not.", "type": "boolean"}, "zbozi_total_clicks": {"description": "Total number of clicks during 24 hours\n\n(counted for the chosen `date`) on Zbozi for the eshop.", "type": "number"}, "zbozi_total_cost": {"description": "(counted for the chosen `date`) on Zbozi for the eshop.", "type": "number"}, "zbozi_xml_feed": {"description": "URL of XML feed containing products entered\n\nin Zbozi.cz administration.", "type": "string"}, "sklik_fenix_total_clicks": {"description": "Total number of clicks during 24 hours\n\n(counted for the chosen `date`) on Sklik (Fenix) for the eshop.", "type": "number"}, "sklik_fenix_total_cost": {"description": "(counted for the chosen `date`) on Sklik (Fenix) for the eshop.", "type": "number"}}, "type": "object"}}}}, "summary": "Get Statistics"}}, "/shops/{id}/stats/audits/": {"get": {"parameters": [{"description": "ID of the project.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"date": "2016-05-03", "error": null, "finished_at": null, "id": "163-160503", "started_at": "2016-05-04T04:50:06+00:00", "status": "in_progress"}, {"date": "2016-05-02", "error": "required_stats_unavailable", "finished_at": "2016-05-03T20:57:09+00:00", "id": "163-160502", "started_at": "2016-05-03T04:50:06+00:00", "status": "error"}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"example": {"data": [{"date": "2016-05-03", "error": null, "finished_at": null, "id": "163-160503", "started_at": "2016-05-04T04:50:06+00:00", "status": "in_progress"}, {"date": "2016-05-02", "error": "required_stats_unavailable", "finished_at": "2016-05-03T20:57:09+00:00", "id": "163-160502", "started_at": "2016-05-03T04:50:06+00:00", "status": "error"}], "limit": 10, "offset": 0, "total_results": 2}, "properties": {"data": {"items": {"properties": {"date": {"type": "string"}, "error": {"nullable": true, "type": "string"}, "finished_at": {"nullable": true, "type": "string"}, "id": {"type": "string"}, "started_at": {"type": "string"}, "status": {"type": "string"}}, "required": ["date", "error", "finished_at", "id", "started_at", "status"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Statistics"], "description": "Returns list of performed audits.\n\n**OAuth2 Scope:** `shop.stats.read`\n\n**GET** `https://api.mergado.com/shops/id/stats/audits/`", "summary": "List of Audits"}}, "/shops/{id}/stats/products/": {"parameters": [{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "ID eshopu"}], "get": {"parameters": [{"description": "ID of the shop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "Date of the collection of the requested statistics.", "in": "query", "name": "date", "required": false, "schema": {"type": "string"}}, {"description": "Currently only filtering by `item id` is supported.\nSee the section [Additional GET parameters](#introduction/additional-get-parameters)\n", "in": "query", "name": "filter_by", "required": false, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"date": "2018-08-08", "stats": {"heureka_actual_cpc": 1.5, "heureka_card_name": "Bioderma Photoderm Max spray na opalování bez parfemace SPF50+ 200 ml", "heureka_category": "Přípravky na opalování", "heureka_categorytext": "Kosmetika a zdraví | Kosmetika | Sluneční ochrana | Přípravky na opalování", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 60, "heureka_feed_cpc": 2, "heureka_id": "123", "heureka_imgurl": "https://www.example.cz/eshop/data/137/img/sprej_50+.jpg", "heureka_manufacturer": "Bioderma", "heureka_max_prices": [526.86, 528, 536, 538, 543, 545, 546, 554, 558, 597], "heureka_min_cpc": 2, "heureka_min_price": 303, "heureka_min_prices": [303, 315, 315, 315, 315, 326, 339, 363, 364, 369], "heureka_name": "BIODERMA Photoderm MAX BIO Sprej SPF 50+ 200 ml", "heureka_popularity": 106, "heureka_price_position": 25, "heureka_price_vat": 449, "heureka_sales": 0, "heureka_segment": "Kosmetika a zdraví", "heureka_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-max-bio-sprej-spf-50.html", "heureka_shops_count": 80, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://pripravky-na-opalovani.heureka.cz/bioderma-photoderm-max-spray-na-opalovani-bez-parfemace-spf50-plus-200-ml", "item_id": "137", "mergado_cost": 209.8, "zbozi_brand": "Bioderma", "zbozi_categorytext": "Kosmetika a drogerie | Kosmetika | Opalování | Přípravky na opalování", "zbozi_delivery_date": 60, "zbozi_imgurl": "https://www.example.cz/eshop/data/137/img/sprej_50+.jpg", "zbozi_manufacturer": "Bioderma", "zbozi_max_cpc": 2.11, "zbozi_max_cpc_search": 1.11, "zbozi_name": "BIODERMA Photoderm MAX BIO Sprej SPF 50+ 200 ml", "zbozi_price_vat": 449, "zbozi_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-max-bio-sprej-spf-50.html?utm_campaign=Kosmetika+a+drogerie+%7C+Kosmetika+%7C+Opalov%C3%A1n%C3%AD+%7C+P%C5%99%C3%ADpravky+na+opalov%C3%A1n%C3%AD&utm_medium=product&utm_source=zbozi.cz"}}, {"date": "2018-08-08", "stats": {"heureka_actual_cpc": 1.5, "heureka_categorytext": "Kosmetika a zdraví | Kosmetika | Sluneční ochrana | Přípravky na opalování", "heureka_delivery_date": 5, "heureka_feed_cpc": 4, "heureka_id": "124", "heureka_imgurl": "https://www.example.cz/eshop/data/142/img/photoderm-family-30-400ml_v.jpg", "heureka_manufacturer": "Bioderma", "heureka_name": "BIODERMA Photoderm Family – Sprej SPF 30", "heureka_price_vat": 359, "heureka_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-family-sprej-spf30.html", "item_id": "142", "mergado_cost": 259.56, "zbozi_avg_position_product_detail": 6, "zbozi_avg_position_top_product_detail": 0, "zbozi_bid_click_through": 0, "zbozi_bid_click_through_category_listing": 0, "zbozi_bid_click_through_category_search": 0, "zbozi_bid_click_through_product_detail": 0, "zbozi_bid_click_through_search_result": 0, "zbozi_bid_click_through_top_product_detail": 0, "zbozi_brand": "Bioderma", "zbozi_card_name": "Bioderma Photoderm Family sprej SPF 30 200 ml ", "zbozi_categorytext": "Kosmetika a drogerie | Kosmetika | Opalování | Přípravky na opalování", "zbozi_conversions": 0, "zbozi_conversions_category_listing": 0, "zbozi_conversions_category_search": 0, "zbozi_conversions_product_detail": 0, "zbozi_conversions_search_result": 0, "zbozi_conversions_top_product_detail": 0, "zbozi_conversions_value_czk": 0, "zbozi_conversions_value_czk_category_listing": 0, "zbozi_conversions_value_czk_category_search": 0, "zbozi_conversions_value_czk_product_detail": 0, "zbozi_conversions_value_czk_search_result": 0, "zbozi_conversions_value_czk_top_product_detail": 0, "zbozi_cpc_czk_category_listing": 0, "zbozi_cpc_czk_category_search": 0, "zbozi_cpc_czk_product_detail": 0, "zbozi_cpc_czk_search_result": 0, "zbozi_cpc_czk_top_product_detail": 0, "zbozi_cpc_czk_vat_category_listing": 0, "zbozi_cpc_czk_vat_category_search": 0, "zbozi_cpc_czk_vat_product_detail": 0, "zbozi_cpc_czk_vat_search_result": 0, "zbozi_cpc_czk_vat_top_product_detail": 0, "zbozi_delivery_date": 5, "zbozi_direct_conversions": 0, "zbozi_id": "i534094664878843228", "zbozi_imgurl": "https://www.example.cz/eshop/data/142/img/photoderm-family-30-400ml_v.jpg", "zbozi_last_known_category": "Kosmetika a drogerie/Kosmetika/Opalování/Přípravky na opalování", "zbozi_manufacturer": "Bioderma", "zbozi_max_cpc": 2.11, "zbozi_max_cpc_search": 1.11, "zbozi_name": "BIODERMA Photoderm Family – Sprej SPF 30", "zbozi_price_vat": 359, "zbozi_products_sold_through_zbozi": 0, "zbozi_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-family-sprej-spf30.html?utm_campaign=Kosmetika+a+drogerie+%7C+Kosmetika+%7C+Opalov%C3%A1n%C3%AD+%7C+P%C5%99%C3%ADpravky+na+opalov%C3%A1n%C3%AD&utm_medium=product&utm_source=zbozi.cz", "zbozi_views_category_listing": 0, "zbozi_views_category_search": 0, "zbozi_views_product_detail": 1, "zbozi_views_search_results": 0, "zbozi_views_top_product_detail": 0}}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"example": {"data": [{"date": "2018-08-08", "stats": {"heureka_actual_cpc": 1.5, "heureka_card_name": "Bioderma Photoderm Max spray na opalování bez parfemace SPF50+ 200 ml", "heureka_category": "Přípravky na opalování", "heureka_categorytext": "Kosmetika a zdraví | Kosmetika | Sluneční ochrana | Přípravky na opalování", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 60, "heureka_feed_cpc": 2, "heureka_id": "123", "heureka_imgurl": "https://www.example.cz/eshop/data/137/img/sprej_50+.jpg", "heureka_manufacturer": "Bioderma", "heureka_max_prices": [526.86, 528, 536, 538, 543, 545, 546, 554, 558, 597], "heureka_min_cpc": 2, "heureka_min_price": 303, "heureka_min_prices": [303, 315, 315, 315, 315, 326, 339, 363, 364, 369], "heureka_name": "BIODERMA Photoderm MAX BIO Sprej SPF 50+ 200 ml", "heureka_popularity": 106, "heureka_price_position": 25, "heureka_price_vat": 449, "heureka_sales": 0, "heureka_segment": "Kosmetika a zdraví", "heureka_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-max-bio-sprej-spf-50.html", "heureka_shops_count": 80, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://pripravky-na-opalovani.heureka.cz/bioderma-photoderm-max-spray-na-opalovani-bez-parfemace-spf50-plus-200-ml", "item_id": "137", "mergado_cost": 209.8, "zbozi_brand": "Bioderma", "zbozi_categorytext": "Kosmetika a drogerie | Kosmetika | Opalování | Přípravky na opalování", "zbozi_delivery_date": 60, "zbozi_imgurl": "https://www.example.cz/eshop/data/137/img/sprej_50+.jpg", "zbozi_manufacturer": "Bioderma", "zbozi_max_cpc": 2.11, "zbozi_max_cpc_search": 1.11, "zbozi_name": "BIODERMA Photoderm MAX BIO Sprej SPF 50+ 200 ml", "zbozi_price_vat": 449, "zbozi_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-max-bio-sprej-spf-50.html?utm_campaign=Kosmetika+a+drogerie+%7C+Kosmetika+%7C+Opalov%C3%A1n%C3%AD+%7C+P%C5%99%C3%ADpravky+na+opalov%C3%A1n%C3%AD&utm_medium=product&utm_source=zbozi.cz"}}, {"date": "2018-08-08", "stats": {"heureka_actual_cpc": 1.5, "heureka_categorytext": "Kosmetika a zdraví | Kosmetika | Sluneční ochrana | Přípravky na opalování", "heureka_delivery_date": 5, "heureka_feed_cpc": 4, "heureka_id": "124", "heureka_imgurl": "https://www.example.cz/eshop/data/142/img/photoderm-family-30-400ml_v.jpg", "heureka_manufacturer": "Bioderma", "heureka_name": "BIODERMA Photoderm Family – Sprej SPF 30", "heureka_price_vat": 359, "heureka_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-family-sprej-spf30.html", "item_id": "142", "mergado_cost": 259.56, "zbozi_avg_position_product_detail": 6, "zbozi_avg_position_top_product_detail": 0, "zbozi_bid_click_through": 0, "zbozi_bid_click_through_category_listing": 0, "zbozi_bid_click_through_category_search": 0, "zbozi_bid_click_through_product_detail": 0, "zbozi_bid_click_through_search_result": 0, "zbozi_bid_click_through_top_product_detail": 0, "zbozi_brand": "Bioderma", "zbozi_card_name": "Bioderma Photoderm Family sprej SPF 30 200 ml ", "zbozi_categorytext": "Kosmetika a drogerie | Kosmetika | Opalování | Přípravky na opalování", "zbozi_conversions": 0, "zbozi_conversions_category_listing": 0, "zbozi_conversions_category_search": 0, "zbozi_conversions_product_detail": 0, "zbozi_conversions_search_result": 0, "zbozi_conversions_top_product_detail": 0, "zbozi_conversions_value_czk": 0, "zbozi_conversions_value_czk_category_listing": 0, "zbozi_conversions_value_czk_category_search": 0, "zbozi_conversions_value_czk_product_detail": 0, "zbozi_conversions_value_czk_search_result": 0, "zbozi_conversions_value_czk_top_product_detail": 0, "zbozi_cpc_czk_category_listing": 0, "zbozi_cpc_czk_category_search": 0, "zbozi_cpc_czk_product_detail": 0, "zbozi_cpc_czk_search_result": 0, "zbozi_cpc_czk_top_product_detail": 0, "zbozi_cpc_czk_vat_category_listing": 0, "zbozi_cpc_czk_vat_category_search": 0, "zbozi_cpc_czk_vat_product_detail": 0, "zbozi_cpc_czk_vat_search_result": 0, "zbozi_cpc_czk_vat_top_product_detail": 0, "zbozi_delivery_date": 5, "zbozi_direct_conversions": 0, "zbozi_id": "i534094664878843228", "zbozi_imgurl": "https://www.example.cz/eshop/data/142/img/photoderm-family-30-400ml_v.jpg", "zbozi_last_known_category": "Kosmetika a drogerie/Kosmetika/Opalování/Přípravky na opalování", "zbozi_manufacturer": "Bioderma", "zbozi_max_cpc": 2.11, "zbozi_max_cpc_search": 1.11, "zbozi_name": "BIODERMA Photoderm Family – Sprej SPF 30", "zbozi_price_vat": 359, "zbozi_products_sold_through_zbozi": 0, "zbozi_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-family-sprej-spf30.html?utm_campaign=Kosmetika+a+drogerie+%7C+Kosmetika+%7C+Opalov%C3%A1n%C3%AD+%7C+P%C5%99%C3%ADpravky+na+opalov%C3%A1n%C3%AD&utm_medium=product&utm_source=zbozi.cz", "zbozi_views_category_listing": 0, "zbozi_views_category_search": 0, "zbozi_views_product_detail": 1, "zbozi_views_search_results": 0, "zbozi_views_top_product_detail": 0}}], "limit": 10, "offset": 0, "total_results": 2}, "properties": {"data": {"items": {"properties": {"date": {"type": "string"}, "stats": {"properties": {"heureka_actual_cpc": {"type": "number"}, "heureka_card_name": {"type": "string"}, "heureka_category": {"type": "string"}, "heureka_categorytext": {"type": "string"}, "heureka_clicks": {"type": "number"}, "heureka_cost_of_sales": {"type": "number"}, "heureka_cpc": {"type": "number"}, "heureka_delivery_date": {"type": "number"}, "heureka_feed_cpc": {"type": "number"}, "heureka_id": {"type": "string"}, "heureka_imgurl": {"type": "string"}, "heureka_manufacturer": {"type": "string"}, "heureka_max_prices": {"items": {"type": "number"}, "type": "array"}, "heureka_min_cpc": {"type": "number"}, "heureka_min_price": {"type": "number"}, "heureka_min_prices": {"items": {"type": "number"}, "type": "array"}, "heureka_name": {"type": "string"}, "heureka_popularity": {"type": "number"}, "heureka_price_position": {"type": "number"}, "heureka_price_vat": {"type": "number"}, "heureka_sales": {"type": "number"}, "heureka_segment": {"type": "string"}, "heureka_shop_url": {"type": "string"}, "heureka_shops_count": {"type": "number"}, "heureka_total_cost": {"type": "number"}, "heureka_total_orders": {"type": "number"}, "heureka_url": {"type": "string"}, "item_id": {"type": "string"}, "mergado_cost": {"type": "number"}, "zbozi_avg_position_product_detail": {"type": "number"}, "zbozi_avg_position_top_product_detail": {"type": "number"}, "zbozi_bid_click_through": {"type": "number"}, "zbozi_bid_click_through_category_listing": {"type": "number"}, "zbozi_bid_click_through_category_search": {"type": "number"}, "zbozi_bid_click_through_product_detail": {"type": "number"}, "zbozi_bid_click_through_search_result": {"type": "number"}, "zbozi_bid_click_through_top_product_detail": {"type": "number"}, "zbozi_brand": {"type": "string"}, "zbozi_card_name": {"type": "string"}, "zbozi_categorytext": {"type": "string"}, "zbozi_conversions": {"type": "number"}, "zbozi_conversions_category_listing": {"type": "number"}, "zbozi_conversions_category_search": {"type": "number"}, "zbozi_conversions_product_detail": {"type": "number"}, "zbozi_conversions_search_result": {"type": "number"}, "zbozi_conversions_top_product_detail": {"type": "number"}, "zbozi_conversions_value_czk": {"type": "number"}, "zbozi_conversions_value_czk_category_listing": {"type": "number"}, "zbozi_conversions_value_czk_category_search": {"type": "number"}, "zbozi_conversions_value_czk_product_detail": {"type": "number"}, "zbozi_conversions_value_czk_search_result": {"type": "number"}, "zbozi_conversions_value_czk_top_product_detail": {"type": "number"}, "zbozi_cpc_czk_category_listing": {"type": "number"}, "zbozi_cpc_czk_category_search": {"type": "number"}, "zbozi_cpc_czk_product_detail": {"type": "number"}, "zbozi_cpc_czk_search_result": {"type": "number"}, "zbozi_cpc_czk_top_product_detail": {"type": "number"}, "zbozi_cpc_czk_vat_category_listing": {"type": "number"}, "zbozi_cpc_czk_vat_category_search": {"type": "number"}, "zbozi_cpc_czk_vat_product_detail": {"type": "number"}, "zbozi_cpc_czk_vat_search_result": {"type": "number"}, "zbozi_cpc_czk_vat_top_product_detail": {"type": "number"}, "zbozi_delivery_date": {"type": "number"}, "zbozi_direct_conversions": {"type": "number"}, "zbozi_id": {"type": "string"}, "zbozi_imgurl": {"type": "string"}, "zbozi_last_known_category": {"type": "string"}, "zbozi_manufacturer": {"type": "string"}, "zbozi_max_cpc": {"type": "number"}, "zbozi_max_cpc_search": {"type": "number"}, "zbozi_name": {"type": "string"}, "zbozi_price_vat": {"type": "number"}, "zbozi_products_sold_through_zbozi": {"type": "number"}, "zbozi_shop_url": {"type": "string"}, "zbozi_views_category_listing": {"type": "number"}, "zbozi_views_category_search": {"type": "number"}, "zbozi_views_product_detail": {"type": "number"}, "zbozi_views_search_results": {"type": "number"}, "zbozi_views_top_product_detail": {"type": "number"}}, "type": "object"}}, "required": ["date", "stats"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Statistics"], "description": "Returns statistics of all products associated with the shop.\nBy default, only the latest statistics (usualy from yesterday)\nare returned. This can be changed by the query string parameter `date`. Note that `product_id` is not returned.\n`after` can be used instead of offset. The value of `after` should be\n`item_id` of the last product from the previous batch.\nThe reason for using `after` is that high offset (> 10k)\ncauses request timeouts on Elastic's side.\nIf `filter_by` contains `_exists_` parameter (with json list of *stats* fields as the param value),\nonly the products that have those fields defined will be returned.\nFor example: `filter_by={\"_exists_\":[\"heureka_cpc\", \"item_id\"]}`\n\n**OAuth2 Scope:** `shop.stats.read`\n\n**GET** `https://api.mergado.com/shops/id/stats/products/?date=&filter_by=`", "summary": "Statistics of All Shop Products"}, "post": {"responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"date": "2018-08-08", "stats": {"heureka_actual_cpc": 1.5, "heureka_card_name": "Bioderma Photoderm Max spray na opalování bez parfemace SPF50+ 200 ml", "heureka_category": "Přípravky na opalování", "heureka_categorytext": "Kosmetika a zdraví | Kosmetika | Sluneční ochrana | Přípravky na opalování", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 60, "heureka_feed_cpc": 2, "heureka_id": "123", "heureka_imgurl": "https://www.example.cz/eshop/data/137/img/sprej_50+.jpg", "heureka_manufacturer": "Bioderma", "heureka_max_prices": [526.86, 528, 536, 538, 543, 545, 546, 554, 558, 597], "heureka_min_cpc": 2, "heureka_min_price": 303, "heureka_min_prices": [303, 315, 315, 315, 315, 326, 339, 363, 364, 369], "heureka_name": "BIODERMA Photoderm MAX BIO Sprej SPF 50+ 200 ml", "heureka_popularity": 106, "heureka_price_position": 25, "heureka_price_vat": 449, "heureka_sales": 0, "heureka_segment": "Kosmetika a zdraví", "heureka_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-max-bio-sprej-spf-50.html", "heureka_shops_count": 80, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://pripravky-na-opalovani.heureka.cz/bioderma-photoderm-max-spray-na-opalovani-bez-parfemace-spf50-plus-200-ml", "item_id": "137", "mergado_cost": 209.8, "zbozi_brand": "Bioderma", "zbozi_categorytext": "Kosmetika a drogerie | Kosmetika | Opalování | Přípravky na opalování", "zbozi_delivery_date": 60, "zbozi_imgurl": "https://www.example.cz/eshop/data/137/img/sprej_50+.jpg", "zbozi_manufacturer": "Bioderma", "zbozi_max_cpc": 2.11, "zbozi_max_cpc_search": 1.11, "zbozi_name": "BIODERMA Photoderm MAX BIO Sprej SPF 50+ 200 ml", "zbozi_price_vat": 449, "zbozi_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-max-bio-sprej-spf-50.html?utm_campaign=Kosmetika+a+drogerie+%7C+Kosmetika+%7C+Opalov%C3%A1n%C3%AD+%7C+P%C5%99%C3%ADpravky+na+opalov%C3%A1n%C3%AD&utm_medium=product&utm_source=zbozi.cz"}}, {"date": "2018-08-08", "stats": {"heureka_actual_cpc": 1.5, "heureka_categorytext": "Kosmetika a zdraví | Kosmetika | Sluneční ochrana | Přípravky na opalování", "heureka_delivery_date": 5, "heureka_feed_cpc": 4, "heureka_id": "124", "heureka_imgurl": "https://www.example.cz/eshop/data/142/img/photoderm-family-30-400ml_v.jpg", "heureka_manufacturer": "Bioderma", "heureka_name": "BIODERMA Photoderm Family – Sprej SPF 30", "heureka_price_vat": 359, "heureka_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-family-sprej-spf30.html", "item_id": "142", "mergado_cost": 259.56, "zbozi_avg_position_product_detail": 6, "zbozi_avg_position_top_product_detail": 0, "zbozi_bid_click_through": 0, "zbozi_bid_click_through_category_listing": 0, "zbozi_bid_click_through_category_search": 0, "zbozi_bid_click_through_product_detail": 0, "zbozi_bid_click_through_search_result": 0, "zbozi_bid_click_through_top_product_detail": 0, "zbozi_brand": "Bioderma", "zbozi_card_name": "Bioderma Photoderm Family sprej SPF 30 200 ml ", "zbozi_categorytext": "Kosmetika a drogerie | Kosmetika | Opalování | Přípravky na opalování", "zbozi_conversions": 0, "zbozi_conversions_category_listing": 0, "zbozi_conversions_category_search": 0, "zbozi_conversions_product_detail": 0, "zbozi_conversions_search_result": 0, "zbozi_conversions_top_product_detail": 0, "zbozi_conversions_value_czk": 0, "zbozi_conversions_value_czk_category_listing": 0, "zbozi_conversions_value_czk_category_search": 0, "zbozi_conversions_value_czk_product_detail": 0, "zbozi_conversions_value_czk_search_result": 0, "zbozi_conversions_value_czk_top_product_detail": 0, "zbozi_cpc_czk_category_listing": 0, "zbozi_cpc_czk_category_search": 0, "zbozi_cpc_czk_product_detail": 0, "zbozi_cpc_czk_search_result": 0, "zbozi_cpc_czk_top_product_detail": 0, "zbozi_cpc_czk_vat_category_listing": 0, "zbozi_cpc_czk_vat_category_search": 0, "zbozi_cpc_czk_vat_product_detail": 0, "zbozi_cpc_czk_vat_search_result": 0, "zbozi_cpc_czk_vat_top_product_detail": 0, "zbozi_delivery_date": 5, "zbozi_direct_conversions": 0, "zbozi_id": "i534094664878843228", "zbozi_imgurl": "https://www.example.cz/eshop/data/142/img/photoderm-family-30-400ml_v.jpg", "zbozi_last_known_category": "Kosmetika a drogerie/Kosmetika/Opalování/Přípravky na opalování", "zbozi_manufacturer": "Bioderma", "zbozi_max_cpc": 2.11, "zbozi_max_cpc_search": 1.11, "zbozi_name": "BIODERMA Photoderm Family – Sprej SPF 30", "zbozi_price_vat": 359, "zbozi_products_sold_through_zbozi": 0, "zbozi_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-family-sprej-spf30.html?utm_campaign=Kosmetika+a+drogerie+%7C+Kosmetika+%7C+Opalov%C3%A1n%C3%AD+%7C+P%C5%99%C3%ADpravky+na+opalov%C3%A1n%C3%AD&utm_medium=product&utm_source=zbozi.cz", "zbozi_views_category_listing": 0, "zbozi_views_category_search": 0, "zbozi_views_product_detail": 1, "zbozi_views_search_results": 0, "zbozi_views_top_product_detail": 0}}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"example": {"data": [{"date": "2018-08-08", "stats": {"heureka_actual_cpc": 1.5, "heureka_card_name": "Bioderma Photoderm Max spray na opalování bez parfemace SPF50+ 200 ml", "heureka_category": "Přípravky na opalování", "heureka_categorytext": "Kosmetika a zdraví | Kosmetika | Sluneční ochrana | Přípravky na opalování", "heureka_clicks": 0, "heureka_cost_of_sales": 0, "heureka_cpc": 0, "heureka_delivery_date": 60, "heureka_feed_cpc": 2, "heureka_id": "123", "heureka_imgurl": "https://www.example.cz/eshop/data/137/img/sprej_50+.jpg", "heureka_manufacturer": "Bioderma", "heureka_max_prices": [526.86, 528, 536, 538, 543, 545, 546, 554, 558, 597], "heureka_min_cpc": 2, "heureka_min_price": 303, "heureka_min_prices": [303, 315, 315, 315, 315, 326, 339, 363, 364, 369], "heureka_name": "BIODERMA Photoderm MAX BIO Sprej SPF 50+ 200 ml", "heureka_popularity": 106, "heureka_price_position": 25, "heureka_price_vat": 449, "heureka_sales": 0, "heureka_segment": "Kosmetika a zdraví", "heureka_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-max-bio-sprej-spf-50.html", "heureka_shops_count": 80, "heureka_total_cost": 0, "heureka_total_orders": 0, "heureka_url": "https://pripravky-na-opalovani.heureka.cz/bioderma-photoderm-max-spray-na-opalovani-bez-parfemace-spf50-plus-200-ml", "item_id": "137", "mergado_cost": 209.8, "zbozi_brand": "Bioderma", "zbozi_categorytext": "Kosmetika a drogerie | Kosmetika | Opalování | Přípravky na opalování", "zbozi_delivery_date": 60, "zbozi_imgurl": "https://www.example.cz/eshop/data/137/img/sprej_50+.jpg", "zbozi_manufacturer": "Bioderma", "zbozi_max_cpc": 2.11, "zbozi_max_cpc_search": 1.11, "zbozi_name": "BIODERMA Photoderm MAX BIO Sprej SPF 50+ 200 ml", "zbozi_price_vat": 449, "zbozi_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-max-bio-sprej-spf-50.html?utm_campaign=Kosmetika+a+drogerie+%7C+Kosmetika+%7C+Opalov%C3%A1n%C3%AD+%7C+P%C5%99%C3%ADpravky+na+opalov%C3%A1n%C3%AD&utm_medium=product&utm_source=zbozi.cz"}}, {"date": "2018-08-08", "stats": {"heureka_actual_cpc": 1.5, "heureka_categorytext": "Kosmetika a zdraví | Kosmetika | Sluneční ochrana | Přípravky na opalování", "heureka_delivery_date": 5, "heureka_feed_cpc": 4, "heureka_id": "124", "heureka_imgurl": "https://www.example.cz/eshop/data/142/img/photoderm-family-30-400ml_v.jpg", "heureka_manufacturer": "Bioderma", "heureka_name": "BIODERMA Photoderm Family – Sprej SPF 30", "heureka_price_vat": 359, "heureka_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-family-sprej-spf30.html", "item_id": "142", "mergado_cost": 259.56, "zbozi_avg_position_product_detail": 6, "zbozi_avg_position_top_product_detail": 0, "zbozi_bid_click_through": 0, "zbozi_bid_click_through_category_listing": 0, "zbozi_bid_click_through_category_search": 0, "zbozi_bid_click_through_product_detail": 0, "zbozi_bid_click_through_search_result": 0, "zbozi_bid_click_through_top_product_detail": 0, "zbozi_brand": "Bioderma", "zbozi_card_name": "Bioderma Photoderm Family sprej SPF 30 200 ml ", "zbozi_categorytext": "Kosmetika a drogerie | Kosmetika | Opalování | Přípravky na opalování", "zbozi_conversions": 0, "zbozi_conversions_category_listing": 0, "zbozi_conversions_category_search": 0, "zbozi_conversions_product_detail": 0, "zbozi_conversions_search_result": 0, "zbozi_conversions_top_product_detail": 0, "zbozi_conversions_value_czk": 0, "zbozi_conversions_value_czk_category_listing": 0, "zbozi_conversions_value_czk_category_search": 0, "zbozi_conversions_value_czk_product_detail": 0, "zbozi_conversions_value_czk_search_result": 0, "zbozi_conversions_value_czk_top_product_detail": 0, "zbozi_cpc_czk_category_listing": 0, "zbozi_cpc_czk_category_search": 0, "zbozi_cpc_czk_product_detail": 0, "zbozi_cpc_czk_search_result": 0, "zbozi_cpc_czk_top_product_detail": 0, "zbozi_cpc_czk_vat_category_listing": 0, "zbozi_cpc_czk_vat_category_search": 0, "zbozi_cpc_czk_vat_product_detail": 0, "zbozi_cpc_czk_vat_search_result": 0, "zbozi_cpc_czk_vat_top_product_detail": 0, "zbozi_delivery_date": 5, "zbozi_direct_conversions": 0, "zbozi_id": "i534094664878843228", "zbozi_imgurl": "https://www.example.cz/eshop/data/142/img/photoderm-family-30-400ml_v.jpg", "zbozi_last_known_category": "Kosmetika a drogerie/Kosmetika/Opalování/Přípravky na opalování", "zbozi_manufacturer": "Bioderma", "zbozi_max_cpc": 2.11, "zbozi_max_cpc_search": 1.11, "zbozi_name": "BIODERMA Photoderm Family – Sprej SPF 30", "zbozi_price_vat": 359, "zbozi_products_sold_through_zbozi": 0, "zbozi_shop_url": "https://www.example.cz/eshop/bioderma-photoderm-family-sprej-spf30.html?utm_campaign=Kosmetika+a+drogerie+%7C+Kosmetika+%7C+Opalov%C3%A1n%C3%AD+%7C+P%C5%99%C3%ADpravky+na+opalov%C3%A1n%C3%AD&utm_medium=product&utm_source=zbozi.cz", "zbozi_views_category_listing": 0, "zbozi_views_category_search": 0, "zbozi_views_product_detail": 1, "zbozi_views_search_results": 0, "zbozi_views_top_product_detail": 0}}], "limit": 10, "offset": 0, "total_results": 2}, "properties": {"data": {"items": {"properties": {"date": {"type": "string"}, "stats": {"properties": {"heureka_actual_cpc": {"type": "number"}, "heureka_card_name": {"type": "string"}, "heureka_category": {"type": "string"}, "heureka_categorytext": {"type": "string"}, "heureka_clicks": {"type": "number"}, "heureka_cost_of_sales": {"type": "number"}, "heureka_cpc": {"type": "number"}, "heureka_delivery_date": {"type": "number"}, "heureka_feed_cpc": {"type": "number"}, "heureka_id": {"type": "string"}, "heureka_imgurl": {"type": "string"}, "heureka_manufacturer": {"type": "string"}, "heureka_max_prices": {"items": {"type": "number"}, "type": "array"}, "heureka_min_cpc": {"type": "number"}, "heureka_min_price": {"type": "number"}, "heureka_min_prices": {"items": {"type": "number"}, "type": "array"}, "heureka_name": {"type": "string"}, "heureka_popularity": {"type": "number"}, "heureka_price_position": {"type": "number"}, "heureka_price_vat": {"type": "number"}, "heureka_sales": {"type": "number"}, "heureka_segment": {"type": "string"}, "heureka_shop_url": {"type": "string"}, "heureka_shops_count": {"type": "number"}, "heureka_total_cost": {"type": "number"}, "heureka_total_orders": {"type": "number"}, "heureka_url": {"type": "string"}, "item_id": {"type": "string"}, "mergado_cost": {"type": "number"}, "zbozi_avg_position_product_detail": {"type": "number"}, "zbozi_avg_position_top_product_detail": {"type": "number"}, "zbozi_bid_click_through": {"type": "number"}, "zbozi_bid_click_through_category_listing": {"type": "number"}, "zbozi_bid_click_through_category_search": {"type": "number"}, "zbozi_bid_click_through_product_detail": {"type": "number"}, "zbozi_bid_click_through_search_result": {"type": "number"}, "zbozi_bid_click_through_top_product_detail": {"type": "number"}, "zbozi_brand": {"type": "string"}, "zbozi_card_name": {"type": "string"}, "zbozi_categorytext": {"type": "string"}, "zbozi_conversions": {"type": "number"}, "zbozi_conversions_category_listing": {"type": "number"}, "zbozi_conversions_category_search": {"type": "number"}, "zbozi_conversions_product_detail": {"type": "number"}, "zbozi_conversions_search_result": {"type": "number"}, "zbozi_conversions_top_product_detail": {"type": "number"}, "zbozi_conversions_value_czk": {"type": "number"}, "zbozi_conversions_value_czk_category_listing": {"type": "number"}, "zbozi_conversions_value_czk_category_search": {"type": "number"}, "zbozi_conversions_value_czk_product_detail": {"type": "number"}, "zbozi_conversions_value_czk_search_result": {"type": "number"}, "zbozi_conversions_value_czk_top_product_detail": {"type": "number"}, "zbozi_cpc_czk_category_listing": {"type": "number"}, "zbozi_cpc_czk_category_search": {"type": "number"}, "zbozi_cpc_czk_product_detail": {"type": "number"}, "zbozi_cpc_czk_search_result": {"type": "number"}, "zbozi_cpc_czk_top_product_detail": {"type": "number"}, "zbozi_cpc_czk_vat_category_listing": {"type": "number"}, "zbozi_cpc_czk_vat_category_search": {"type": "number"}, "zbozi_cpc_czk_vat_product_detail": {"type": "number"}, "zbozi_cpc_czk_vat_search_result": {"type": "number"}, "zbozi_cpc_czk_vat_top_product_detail": {"type": "number"}, "zbozi_delivery_date": {"type": "number"}, "zbozi_direct_conversions": {"type": "number"}, "zbozi_id": {"type": "string"}, "zbozi_imgurl": {"type": "string"}, "zbozi_last_known_category": {"type": "string"}, "zbozi_manufacturer": {"type": "string"}, "zbozi_max_cpc": {"type": "number"}, "zbozi_max_cpc_search": {"type": "number"}, "zbozi_name": {"type": "string"}, "zbozi_price_vat": {"type": "number"}, "zbozi_products_sold_through_zbozi": {"type": "number"}, "zbozi_shop_url": {"type": "string"}, "zbozi_views_category_listing": {"type": "number"}, "zbozi_views_category_search": {"type": "number"}, "zbozi_views_product_detail": {"type": "number"}, "zbozi_views_search_results": {"type": "number"}, "zbozi_views_top_product_detail": {"type": "number"}}, "type": "object"}}, "required": ["date", "stats"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Statistics"], "description": "Returns statistics of all products associated with the shop.\nBy default, only the latest statistics (usualy from yesterday)\nare returned. This can be changed by the query string parameter `date`.\n`after` can be used instead of offset. The value of `after` should be\n`item_id` of the last product from the previous batch.\nThe reason for using `after` is that high offset (> 10k)\ncauses request timeouts on Elastic's side.\nIf `filter_by` contains `_exists_` parameter (with json list of *stats* fields as the param value),\nonly the products that have those fields defined will be returned.\nFor example: `filter_by={\"_exists_\":[\"heureka_cpc\", \"item_id\"]}`\n\n**OAuth2 Scope:** `shop.stats.read`\n\n**POST** `https://api.mergado.com/shops/id/stats/products/`\n\n**Attributes:** \n * **date (string):** Date of the collection of the requested statistics. \n\n * **filter_by (string):** Currently only filtering by item_id is supported. See the section Additional GET parameters. \n\n ---", "requestBody": {"content": {"application/json": {"schema": {"example": {"date": "2016-02-02", "filter_by": {"item_id__in": ["a", "b", "c"]}}, "properties": {"date": {"description": "Date of the collection of the requested statistics.", "type": "string"}, "filter_by": {"description": "Currently only filtering by `item id` is supported.\n\nSee the section [Additional GET parameters](#introduction/additional-get-parameters).", "type": "string"}}, "type": "object"}}}}, "summary": "Statistics of All Shop Products using POST"}}, "/shops/{id}/stats/sources/": {"get": {"parameters": [{"description": "ID of the eshop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"feed_url": "http://feeds.mergado.com/feed.xml", "id": "65", "shop_id": "1", "type": "feed"}, {"feed_url": "https://www.heureka.cz/direct/xml-export/shops/roi/feed.xml.gz", "id": "66", "shop_id": "1", "type": "heureka"}, {"feed_url": "https://feeds.mergado.com/feed.xml", "id": "64", "shop_id": "1", "type": "mergado"}], "limit": 10, "offset": 0, "total_results": 3}}}, "schema": {"example": {"data": [{"feed_url": "http://feeds.mergado.com/feed.xml", "id": "65", "shop_id": "1", "type": "feed"}, {"feed_url": "https://www.heureka.cz/direct/xml-export/shops/roi/feed.xml.gz", "id": "66", "shop_id": "1", "type": "heureka"}, {"feed_url": "https://feeds.mergado.com/feed.xml", "id": "64", "shop_id": "1", "type": "mergado"}], "limit": 10, "offset": 0, "total_results": 3}, "properties": {"data": {"items": {"properties": {"feed_url": {"type": "string"}, "id": {"type": "string"}, "shop_id": {"type": "string"}, "type": {"type": "string"}}, "required": ["feed_url", "id", "shop_id", "type"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Statistics"], "description": "Returns a list of all sources of a specific shop.\n\n**OAuth2 Scope:** `shop.stats.source.read`\n\n\n**GET** `https://api.mergado.com/shops/id/stats/sources/`\n\n**Attributes:** \n * **id (string):** Id of the source. \n\n * **feed_url (string):** URL of the source. \n\n * **type (string):** Type of the source, e.g. heureka. \n\n * **shop_id (string):** Id of the shop. \n\n ---", "summary": "List All Sources"}}, "/shops/{id}/statslogs/": {"get": {"parameters": [{"description": "ID of the shop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": [{"created_at": "2014-07-02T11:54:37.123456+00:00", "error": null, "finished_at": "2014-07-02T11:56:00.123456+00:00", "id": "130", "items": 21839, "shop_id": "2", "started_at": "2014-07-02T11:55:34.123456+00:00", "status": "done", "type": "heureka"}, {"created_at": "2014-07-02T11:54:37.123456+00:00", "error": "heureka_auth_error", "finished_at": "2014-07-02T11:56:00.123456+00:00", "id": "129", "items": null, "shop_id": "2", "started_at": "2014-07-02T11:55:34.123456+00:00", "status": "error", "type": "sortiment"}]}}, "schema": {"example": [{"created_at": "2014-07-02T11:54:37.123456+00:00", "error": null, "finished_at": "2014-07-02T11:56:00.123456+00:00", "id": "130", "items": 21839, "shop_id": "2", "started_at": "2014-07-02T11:55:34.123456+00:00", "status": "done", "type": "heureka"}, {"created_at": "2014-07-02T11:54:37.123456+00:00", "error": "heureka_auth_error", "finished_at": "2014-07-02T11:56:00.123456+00:00", "id": "129", "items": null, "shop_id": "2", "started_at": "2014-07-02T11:55:34.123456+00:00", "status": "error", "type": "sortiment"}], "items": {"properties": {"created_at": {"type": "string"}, "error": {"nullable": true, "type": "string"}, "finished_at": {"type": "string"}, "id": {"type": "string"}, "items": {"nullable": true, "type": "number"}, "shop_id": {"type": "string"}, "started_at": {"type": "string"}, "status": {"type": "string"}, "type": {"type": "string"}}, "required": ["id", "type", "status", "error", "items", "created_at", "started_at", "finished_at", "shop_id"], "type": "object"}, "type": "array"}}}, "description": "OK", "headers": {}}}, "tags": ["Statistics"], "description": "Returns all *logs* of the import of statistics.\n\n**OAuth2 Scope:** `shop.stats.read`\n\n**GET** `https://api.mergado.com/shops/id/statslogs/`", "summary": "List All Logs of a Shop"}}, "/shops/{id}/unas/proxy/{path}": {"parameters": [{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "ID eshopu"}, {"name": "path", "in": "path", "required": true, "schema": {"type": "string"}, "description": "Konkrétní cesta pro Upgates (Unas) API"}], "delete": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["UNAS"], "description": "Returns response from UNAS API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**DELETE** `https://api.mergado.com/shops/id/unas/proxy/path`", "summary": "Delete Request"}, "get": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["UNAS"], "description": "Returns response from UNAS API.\n\n**OAuth2 Scope:** `shop.proxy.read`\n\n\n**GET** `https://api.mergado.com/shops/id/unas/proxy/path`", "summary": "Get Request"}, "post": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["UNAS"], "description": "Returns response from UNAS API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n\n**POST** `https://api.mergado.com/shops/id/unas/proxy/path`", "summary": "Post Request"}, "put": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["UNAS"], "description": "Returns response from UNAS API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n\n**PUT** `https://api.mergado.com/shops/id/unas/proxy/path`"}}, "/shops/{id}/sklik_fenix/proxy/{path}": {"parameters": [{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "ID eshopu"}, {"name": "path", "in": "path", "required": true, "schema": {"type": "string"}, "description": "Konkrétní cesta pro Sklik Fenix API"}], "get": {"summary": "Get Request", "tags": ["Sklik - Fenix"], "description": "Returns response from Sklik Fenix API.\n**OAuth2 Scope:** `shop.proxy.read`\n\n**GET** `https://api.mergado.com/shops/id/sklik_fenix/proxy/path`", "responses": {"200": {"description": "OK"}}}, "post": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Sklik - Fenix"], "description": "Returns response from Sklik Fenix API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**POST** `https://api.mergado.com/shops/id/sklik_fenix/proxy/path`", "summary": "Post Request"}, "put": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Sklik - Fenix"], "description": "Returns response from Sklik Fenix API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**PUT** `https://api.mergado.com/shops/id/sklik_fenix/proxy/path`", "summary": "Put Request"}, "delete": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Sklik - Fenix"], "description": "Returns response from Sklik Fenix API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**DELETE** `https://api.mergado.com/shops/id/sklik_fenix/proxy/path`", "summary": "Delete Request"}}, "/shops/{id}/woocommerce/proxy/{path}": {"parameters": [{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "ID eshopu"}, {"name": "path", "in": "path", "required": true, "schema": {"type": "string"}, "description": "Konkrétní cesta pro WooCommerce API"}], "delete": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["WooCommerce"], "description": "Returns response from WooCommerce API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**DELETE** `https://api.mergado.com/shops/id/woocommerce/proxy/path`", "summary": "Delete Request"}, "get": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["WooCommerce"], "description": "Returns response from WooCommerce API.\n\n**OAuth2 Scope:** `shop.proxy.read`\n\n**GET** `https://api.mergado.com/shops/id/woocommerce/proxy/path`", "summary": "Get Request"}, "post": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["WooCommerce"], "description": "Returns response from WooCommerce API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**POST** `https://api.mergado.com/shops/id/woocommerce/proxy/path`", "summary": "Post Request"}, "put": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["WooCommerce"], "description": "Returns response from WooCommerce API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**PUT** `https://api.mergado.com/shops/id/woocommerce/proxy/path`", "summary": "Put Request"}}, "/shops/{id}/zbozi/proxy/{path}": {"parameters": [{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "ID eshopu"}, {"name": "path", "in": "path", "required": true, "schema": {"type": "string"}, "description": "Cesta pro Zbozi API"}], "delete": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Zbozi"], "description": "Returns response from Zbozi.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**DELETE** `https://api.mergado.com/shops/id/zbozi/proxy/path`", "summary": "Delete Request"}, "get": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Zbozi"], "description": "Returns response from Zbozi API.\n\n**OAuth2 Scope:** `shop.proxy.read`\n\n**GET** `https://api.mergado.com/shops/id/zbozi/proxy/path`", "summary": "Get Request"}, "post": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Zbozi"], "description": "Returns response from Zbozi API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**POST** `https://api.mergado.com/shops/id/zbozi/proxy/path`", "summary": "Post Request"}, "put": {"responses": {"200": {"description": "OK", "headers": {}}}, "tags": ["Zbozi"], "description": "Returns response from Zbozi API.\n\n**OAuth2 Scope:** `shop.proxy.write`\n\n**PUT** `https://api.mergado.com/shops/id/zbozi/proxy/path`", "summary": "Put Request"}}, "/shops/{id}/{connection}/validate": {"get": {"parameters": [{"description": "ID of an eshop.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "Name of the connection to validate (e.g., `heureka.cz`, `zbozi.cz`, `shoptet.cz`).", "in": "path", "name": "connection", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"errors": [{"error": "invalid_credentials", "message": "Invalid username or password."}], "is_valid": false}}}, "schema": {"properties": {"errors": {"description": "List of validation errors (empty if connection is valid).", "items": {}, "type": "array"}, "is_valid": {"description": "Whether the connection is valid. Can be `null` when an error occurs during validation that cannot be evaluated, which may indicate that the external service has an outage or is behaving unexpectedly.", "nullable": true, "type": "boolean"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Eshops"], "description": "Validate a specific connection for an eshop. The connection name should match one of the connection names returned by the `/shops/{id}/info` endpoint.\n\n**Oauth2 Scope:** `shop.read`\n\n**GET** `https://api.mergado.com/shops/id/connection/validate` ", "summary": "Validate Keychain Connection"}}, "/stats/audits/{id}/": {"get": {"parameters": [{"description": "ID of the audit.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"date": "2016-04-19", "error": null, "finished_at": "2016-04-20T12:22:49+00:00", "id": "163-160419", "issues": {"heureka_category_name": {"missing_stats": {"count": 30, "items": 383}, "ok": {"count": 114, "items": 383}, "wrong": {"count": 239, "items": 383}}, "heureka_cpc_status": {"decreased": {"count": 238, "items": 24989}, "low": {"count": 147, "items": 24989}, "ok": {"count": 24604, "items": 24989}}, "heureka_is_paired": {"ok": {"count": 20758, "items": 24989}, "wrong": {"count": 4231, "items": 24989}}, "heureka_margin_status": {"ok": {"count": 24989, "items": 24989}}, "heureka_not_alone": {"alone": {"count": 13411, "items": 24989}, "ok": {"count": 11578, "items": 24989}}}, "product_count": 24989, "started_at": "2016-04-20T11:56:50+00:00", "status": "done"}}}, "schema": {"example": {"date": "2016-04-19", "error": null, "finished_at": "2016-04-20T12:22:49+00:00", "id": "163-160419", "issues": {"heureka_category_name": {"missing_stats": {"count": 30, "items": 383}, "ok": {"count": 114, "items": 383}, "wrong": {"count": 239, "items": 383}}, "heureka_cpc_status": {"decreased": {"count": 238, "items": 24989}, "low": {"count": 147, "items": 24989}, "ok": {"count": 24604, "items": 24989}}, "heureka_is_paired": {"ok": {"count": 20758, "items": 24989}, "wrong": {"count": 4231, "items": 24989}}, "heureka_margin_status": {"ok": {"count": 24989, "items": 24989}}, "heureka_not_alone": {"alone": {"count": 13411, "items": 24989}, "ok": {"count": 11578, "items": 24989}}}, "product_count": 24989, "started_at": "2016-04-20T11:56:50+00:00", "status": "done"}, "properties": {"date": {"type": "string"}, "error": {"nullable": true}, "finished_at": {"type": "string"}, "id": {"type": "string"}, "issues": {"properties": {"heureka_category_name": {"properties": {"missing_stats": {"properties": {"count": {"type": "number"}, "items": {"type": "number"}}, "type": "object"}, "ok": {"properties": {"count": {"type": "number"}, "items": {"type": "number"}}, "type": "object"}, "wrong": {"properties": {"count": {"type": "number"}, "items": {"type": "number"}}, "type": "object"}}, "type": "object"}, "heureka_cpc_status": {"properties": {"decreased": {"properties": {"count": {"type": "number"}, "items": {"type": "number"}}, "type": "object"}, "low": {"properties": {"count": {"type": "number"}, "items": {"type": "number"}}, "type": "object"}, "ok": {"properties": {"count": {"type": "number"}, "items": {"type": "number"}}, "type": "object"}}, "type": "object"}, "heureka_is_paired": {"properties": {"ok": {"properties": {"count": {"type": "number"}, "items": {"type": "number"}}, "type": "object"}, "wrong": {"properties": {"count": {"type": "number"}, "items": {"type": "number"}}, "type": "object"}}, "type": "object"}, "heureka_margin_status": {"properties": {"ok": {"properties": {"count": {"type": "number"}, "items": {"type": "number"}}, "type": "object"}}, "type": "object"}, "heureka_not_alone": {"properties": {"alone": {"properties": {"count": {"type": "number"}, "items": {"type": "number"}}, "type": "object"}, "ok": {"properties": {"count": {"type": "number"}, "items": {"type": "number"}}, "type": "object"}}, "type": "object"}}, "type": "object"}, "product_count": {"type": "number"}, "started_at": {"type": "string"}, "status": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Statistics"], "description": "Returns a performed audit.\n\n**OAuth2 Scope:** `shop.stats.read`\n\n**GET** `https://api.mergado.com/stats/audits/id/`", "summary": "Get an Audit"}}, "/stats/audits/{id}/issues/": {"get": {"parameters": [{"description": "ID of the audit.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "Filters to apply to the response.", "in": "query", "name": "filter_by", "required": false, "schema": {"type": "string"}}, {"description": "Sorting to apply to the response.", "in": "query", "name": "order_by", "required": false, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"info": {"price_vat": 199}, "audit_id": "163-160419", "item_id": "1835", "product_id": null, "validator": "heureka_is_paired", "verdict": "wrong"}], "limit": 10, "offset": 0, "total_results": 1}}}, "schema": {"example": {"data": [{"info": {"price_vat": 199}, "audit_id": "163-160419", "item_id": "1835", "product_id": null, "validator": "heureka_is_paired", "verdict": "wrong"}], "limit": 10, "offset": 0, "total_results": 1}, "properties": {"data": {"items": {"properties": {"info": {"properties": {"price_vat": {"type": "number"}}, "type": "object"}, "audit_id": {"type": "string"}, "item_id": {"type": "string"}, "product_id": {"nullable": true}, "validator": {"type": "string"}, "verdict": {"type": "string"}}, "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Statistics"], "description": "Returns list of issues of an audit.\n\n**OAuth2 Scope:** `shop.stats.read`\n\n**GET** `https://api.mergado.com/stats/audits/id/issues/?filter_by=&order_by=`", "summary": "List Issues"}}, "/stats/sources/{id}/": {"get": {"parameters": [{"description": "ID of the source.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"feed_url": "https://feeds.mergado.com/feed.xml", "id": "64", "shop_id": "1", "type": "mergado"}}}, "schema": {"example": {"feed_url": "https://feeds.mergado.com/feed.xml", "id": "64", "shop_id": "1", "type": "mergado"}, "properties": {"feed_url": {"type": "string"}, "id": {"type": "string"}, "shop_id": {"type": "string"}, "type": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Statistics"], "description": "Return a source of statistics.\n\n**OAuth2 Scope:** `shop.stats.source.read`\n\n**GET** `https://api.mergado.com/stats/sources/id/`", "summary": "Get a Source"}}, "/statslogs/{id}/": {"get": {"parameters": [{"description": "ID of a log.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"created_at": "2014-07-02T11:54:37.123456+00:00", "error": null, "finished_at": "2014-07-02T11:56:00.123456+00:00", "id": "130", "items": 21839, "shop_id": "2", "started_at": "2014-07-02T11:55:34.123456+00:00", "status": "done", "type": "heureka"}}}, "schema": {"example": {"created_at": "2014-07-02T11:54:37.123456+00:00", "error": null, "finished_at": "2014-07-02T11:56:00.123456+00:00", "id": "130", "items": 21839, "shop_id": "2", "started_at": "2014-07-02T11:55:34.123456+00:00", "status": "done", "type": "heureka"}, "properties": {"created_at": {"type": "string"}, "error": {"nullable": true}, "finished_at": {"type": "string"}, "id": {"type": "string"}, "items": {"type": "number"}, "shop_id": {"type": "string"}, "started_at": {"type": "string"}, "status": {"type": "string"}, "type": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Statistics"], "description": "Returns a *log* of the import of statistics with the given ID.\n\n**OAuth2 Scope:** `shop.stats.read`\n\n**GET** `https://api.mergado.com/statslogs/id/`", "summary": "Get a Log of the Import of Statistics"}}, "/tariffs/": {"get": {"responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"id": "2", "name": "Basic", "price_czk": 286, "price_eur": 11, "price_gbp": 9, "price_pln": 49, "price_usd": 12}, {"id": "3", "name": "Standard", "price_czk": 586, "price_eur": 22, "price_gbp": 19, "price_pln": 99, "price_usd": 22}, {"id": "4", "name": "Advanced", "price_czk": 1286, "price_eur": 49, "price_gbp": 49, "price_pln": 219, "price_usd": 52}, {"id": "6", "name": "Special 300", "price_czk": 1786, "price_eur": 70, "price_gbp": 59, "price_pln": 299, "price_usd": 72}, {"id": "7", "name": "Special 400", "price_czk": 2286, "price_eur": 89, "price_gbp": 75, "price_pln": 379, "price_usd": 92}, {"id": "8", "name": "Special 500", "price_czk": 2768, "price_eur": 108, "price_gbp": 89, "price_pln": 459, "price_usd": 112}, {"id": "9", "name": "Special 600", "price_czk": 3286, "price_eur": 129, "price_gbp": 105, "price_pln": 549, "price_usd": 132}], "limit": 10, "offset": 0, "total_results": 8}}}, "schema": {"example": {"data": [{"id": "2", "name": "Basic", "price_czk": 286, "price_eur": 11, "price_gbp": 9, "price_pln": 49, "price_usd": 12}, {"id": "3", "name": "Standard", "price_czk": 586, "price_eur": 22, "price_gbp": 19, "price_pln": 99, "price_usd": 22}, {"id": "4", "name": "Advanced", "price_czk": 1286, "price_eur": 49, "price_gbp": 49, "price_pln": 219, "price_usd": 52}, {"id": "6", "name": "Special 300", "price_czk": 1786, "price_eur": 70, "price_gbp": 59, "price_pln": 299, "price_usd": 72}, {"id": "7", "name": "Special 400", "price_czk": 2286, "price_eur": 89, "price_gbp": 75, "price_pln": 379, "price_usd": 92}, {"id": "8", "name": "Special 500", "price_czk": 2768, "price_eur": 108, "price_gbp": 89, "price_pln": 459, "price_usd": 112}, {"id": "9", "name": "Special 600", "price_czk": 3286, "price_eur": 129, "price_gbp": 105, "price_pln": 549, "price_usd": 132}], "limit": 10, "offset": 0, "total_results": 8}, "properties": {"data": {"items": {"properties": {"id": {"type": "string"}, "name": {"type": "string"}, "price_czk": {"type": "number"}, "price_eur": {"type": "number"}, "price_gbp": {"type": "number"}, "price_pln": {"type": "number"}, "price_usd": {"type": "number"}}, "required": ["id", "name", "price_czk", "price_eur", "price_pln", "price_usd", "price_gbp"], "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Base"], "description": "Returns available tariffs which are automatically chosen for each eshop. **GET** `https://api.mergado.com/tariffs/`", "summary": "List Available Tariffs"}}, "/tariffs/{id}/": {"get": {"parameters": [{"description": "Tariff ID.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"id": "3", "name": "Standard", "price_czk": 586, "price_eur": 22, "price_gbp": 19, "price_pln": 99, "price_usd": 22}}}, "schema": {"example": {"id": "3", "name": "Standard", "price_czk": 586, "price_eur": 22, "price_gbp": 19, "price_pln": 99, "price_usd": 22}, "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "price_czk": {"type": "number"}, "price_eur": {"type": "number"}, "price_gbp": {"type": "number"}, "price_pln": {"type": "number"}, "price_usd": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Base"], "description": "Returns requested tariff by its ID. **GET** `https://api.mergado.com/tariffs/id/`", "summary": "Get Tariff"}}, "/users/": {"get": {"responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"avatars": {"30": "https://www.url.com/img1.png", "80": "https://www.url.com/img2.png"}, "city": "Brno", "company": "Mergado", "country": "cz", "dic": "00000000", "email": "lorem.ipsum@example.com", "fakturoid_id": null, "first_name": "Lorem", "ico": "00000000", "id": "6", "invoice_months": 1, "invoicing_validity_date": "2024-11-23", "last_access": "2016-03-21T16:32:32+00:00", "last_name": "Ipsum", "locale": "cs_CZ", "name": "Lorem Ipsum", "phone": "+420776276550", "postcode": "61200", "registered_at": "2015-11-03T16:08:17+00:00", "send_summary": false, "street": "Palackého 123/456", "timezone": "Europe/Prague", "timezone_offset": null, "username": "loremipsum"}], "limit": 10, "offset": 0, "total_results": 1}}}, "schema": {"example": {"data": [{"avatars": {"30": "https://www.url.com/img1.png", "80": "https://www.url.com/img2.png"}, "city": "Brno", "company": "Mergado", "country": "cz", "dic": "00000000", "email": "lorem.ipsum@example.com", "fakturoid_id": null, "first_name": "Lorem", "ico": "00000000", "id": "6", "invoice_months": 1, "invoicing_validity_date": "2024-11-23", "last_access": "2016-03-21T16:32:32+00:00", "last_name": "Ipsum", "locale": "cs_CZ", "name": "Lorem Ipsum", "phone": "+420776276550", "postcode": "61200", "registered_at": "2015-11-03T16:08:17+00:00", "send_summary": false, "street": "Palackého 123/456", "timezone": "Europe/Prague", "timezone_offset": null, "username": "loremipsum"}], "limit": 10, "offset": 0, "total_results": 1}, "properties": {"data": {"items": {"properties": {"avatars": {"properties": {"30": {"type": "string"}, "80": {"type": "string"}}, "type": "object"}, "city": {"type": "string"}, "company": {"type": "string"}, "country": {"type": "string"}, "dic": {"type": "string"}, "email": {"type": "string"}, "fakturoid_id": {"nullable": true}, "first_name": {"type": "string"}, "ico": {"type": "string"}, "id": {"type": "string"}, "invoice_months": {"type": "number"}, "invoicing_validity_date": {"type": "string"}, "last_access": {"type": "string"}, "last_name": {"type": "string"}, "locale": {"type": "string"}, "name": {"type": "string"}, "phone": {"type": "string"}, "postcode": {"type": "string"}, "registered_at": {"type": "string"}, "send_summary": {"type": "boolean"}, "street": {"type": "string"}, "timezone": {"type": "string"}, "timezone_offset": {"nullable": true}, "username": {"type": "string"}}, "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Users"], "description": "Lists all users the authenticated client has access to.\n\n**OAuth2 Scope:** `user.read`\n\n\n**GET** `https://api.mergado.com/users/`", "summary": "List Users"}}, "/users/{user_identifier}/": {"get": {"parameters": [{"description": "ID or username of a user.", "in": "path", "name": "user_identifier", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"avatars": {"30": "https://www.url.com/img1.png", "80": "https://www.url.com/img2.png"}, "city": "Brno", "company": "Mergado", "country": "cz", "dic": "00000000", "email": "lorem.ipsum@example.com", "fakturoid_id": null, "first_name": "Lorem", "ico": "00000000", "id": "6", "invoice_months": 1, "invoicing_validity_date": "2024-11-23", "last_access": "2016-03-21T16:32:32+00:00", "last_name": "Ipsum", "locale": "cs_CZ", "name": "Lorem Ipsum", "phone": "+420776276550", "postcode": "61200", "registered_at": "2015-11-03T16:08:17+00:00", "send_summary": false, "street": "Palackého 123/456", "timezone": "Europe/Prague", "timezone_offset": null, "username": "loremipsum"}}}, "schema": {"example": {"avatars": {"30": "https://www.url.com/img1.png", "80": "https://www.url.com/img2.png"}, "city": "Brno", "company": "Mergado", "country": "cz", "dic": "00000000", "email": "lorem.ipsum@example.com", "fakturoid_id": null, "first_name": "Lorem", "ico": "00000000", "id": "6", "invoice_months": 1, "invoicing_validity_date": "2024-11-23", "last_access": "2016-03-21T16:32:32+00:00", "last_name": "Ipsum", "locale": "cs_CZ", "name": "Lorem Ipsum", "phone": "+420776276550", "postcode": "61200", "registered_at": "2015-11-03T16:08:17+00:00", "send_summary": false, "street": "Palackého 123/456", "timezone": "Europe/Prague", "timezone_offset": null, "username": "loremipsum"}, "properties": {"avatars": {"properties": {"30": {"type": "string"}, "80": {"type": "string"}}, "type": "object"}, "city": {"type": "string"}, "company": {"type": "string"}, "country": {"type": "string"}, "dic": {"type": "string"}, "email": {"type": "string"}, "fakturoid_id": {"nullable": true}, "first_name": {"type": "string"}, "ico": {"type": "string"}, "id": {"type": "string"}, "invoice_months": {"type": "number"}, "invoicing_validity_date": {"type": "string"}, "last_access": {"type": "string"}, "last_name": {"type": "string"}, "locale": {"type": "string"}, "name": {"type": "string"}, "phone": {"type": "string"}, "postcode": {"type": "string"}, "registered_at": {"type": "string"}, "send_summary": {"type": "boolean"}, "street": {"type": "string"}, "timezone": {"type": "string"}, "timezone_offset": {"nullable": true}, "username": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Users"], "description": "Returns a user.\n\n**OAuth2 Scope:** `user.read`\n\n\n**GET** `https://api.mergado.com/users/user_identifier/` ", "summary": "Get User"}}, "/users/{user_identifier}/apps/": {"get": {"parameters": [{"description": "ID or username of a user.", "in": "path", "name": "user_identifier", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"type": "object", "properties": {"data": {"type": "array", "items": {"$ref": "#/components/schemas/Apps"}}, "limit": {"type": "integer"}, "offset": {"type": "integer"}, "total_results": {"type": "integer"}}}, "examples": {"response": {"value": {"data": [{"app_name": "userappone", "free_until": "2015-01-09", "paid_until": "2016-01-08"}]}}}}}, "headers": {}}}, "tags": ["Enabled Apps"], "description": "Lists apps enabled by the given user.\n\n**OAuth2 Scope:** `user.apps.read`\n\n**GET** `https://api.mergado.com/users/user_identifier/apps/`", "summary": "List User Apps"}}, "/users/{user_identifier}/apps/{name}/": {"get": {"parameters": [{"description": "ID or username of a user.", "in": "path", "name": "user_identifier", "required": true, "schema": {"type": "string"}}, {"description": "Name of an app.", "in": "path", "name": "name", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"app_name": "userappone", "free_until": "2015-01-09", "paid_until": "2016-01-08"}}}, "schema": {"example": {"app_name": "userappone", "free_until": "2015-01-09", "paid_until": "2016-01-08"}, "properties": {"app_name": {"type": "string"}, "free_until": {"type": "string"}, "paid_until": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Enabled Apps"], "description": "Fetches an app enabled by the given user.\n\n**OAuth2 Scope:** `user.apps.read`\n\n**GET** `https://api.mergado.com/users/user_identifier/apps/name/`", "summary": "Get User App"}, "patch": {"parameters": [{"description": "ID or username of a user.", "in": "path", "name": "user_identifier", "required": true, "schema": {"type": "string"}}, {"description": "Name of an app.", "in": "path", "name": "name", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"app_name": "userappone", "free_until": "2015-01-09", "paid_until": "2016-02-08"}}}, "schema": {"example": {"app_name": "userappone", "free_until": "2015-01-09", "paid_until": "2016-02-08"}, "properties": {"app_name": {"type": "string"}, "free_until": {"type": "string"}, "paid_until": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Enabled Apps"], "description": "Updates an app enabled by the given user.\n\n**OAuth2 Scope:** `user.apps.write`\n\n**PATCH** `https://api.mergado.com/users/user_identifier/apps/name/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"paid_until": "2016-02-08"}, "properties": {"paid_until": {"type": "string"}}, "type": "object"}}}}, "summary": "Update User App"}}, "/users/{user_identifier}/billing/": {"get": {"parameters": [{"description": "User ID or username.", "in": "path", "name": "user_identifier", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Billing"}, "examples": {"response": {"value": {"user_identifier": "123", "currency": "CZK", "total_current_price": 1500, "apps": {"apps": [{"app_name": "application"}], "currency": "CZK", "total_current_price": 500}}}}}}, "headers": {}}}, "tags": ["Billing"], "description": "Returns whole billing details for given user.\n\n**OAuth2 Scope:** `user.billing.read`\n\n\n**GET** `https://api.mergado.com/users/user_identifier/billing/`", "summary": "Get User Billing"}}, "/users/{user_identifier}/formats/{format_id}": {"get": {"parameters": [{"description": "ID or username of a user.", "in": "path", "name": "user_identifier", "required": true, "schema": {"type": "string"}}, {"description": "ID of a custom format.", "in": "path", "name": "format_id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"*/*": {"schema": {"properties": {"country": {"description": "Formats country.", "type": "string"}, "extension": {"description": "Formats extension (xml, csv..).", "type": "string"}, "mappings": {"description": "List of FormatMappings.", "properties": {"format_id": {"description": "Format id.", "type": "string"}, "is_wrapper": {"description": "Tells us if the element wraps other elements.", "type": "boolean"}, "order": {"description": "Order of given element.", "type": "string"}, "parent": {"description": "Xpath of elements parent.", "type": "string"}, "target": {"description": "Mergado target for given element.", "type": "string"}, "type": {"description": "Format mappings type.", "type": "string"}, "xpath": {"description": "Xpath of given element.", "type": "string"}}, "type": "object"}, "name": {"description": "Name of the format.", "type": "string"}, "url": {"description": "Link to feed that format is based on.", "type": "string"}, "user_id": {"description": "ID of the user the format relates to.", "type": "string"}, "visibility": {"description": "X", "type": "boolean"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Users"], "description": "Returns user custom formats.\n\n**OAuth2 Scope:** user.formats.read\n\n\n**GET** `https://api.mergado.com/users/user_identifier/formats/format_id` \n\n\n**Attributes:**\n * **user_id (string):** ID of the user the format relates to. \n\n * **url (string):** Link to feed that format is based on. \n\n * **name (string):** Name of the format. \n\n * **extension (string):** Formats extension (xml, csv..). \n\n * **visibility (boolean):** X \n\n * **country (string):** Formats country. \n\n * **mappings (object):**\n \n ---", "summary": "Get User Custom Formats"}}, "/users/{user_identifier}/notifications/": {"get": {"parameters": [{"description": "ID or username of a user.", "in": "path", "name": "user_identifier", "required": true, "schema": {"type": "string"}}, {"description": "", "in": "query", "name": "limit", "required": false, "schema": {"type": "number"}}, {"description": "", "in": "query", "name": "filter", "required": false, "schema": {"type": "string"}}, {"description": "", "in": "query", "name": "offset", "required": false, "schema": {"type": "number"}}, {"description": "", "in": "query", "name": "fields", "required": false, "schema": {"type": "string"}}], "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"id": "30", "event": "app_notify", "scope": "eshop", "priority": "medium", "data": {"title": "E-shop is happy", "body": "There seems not to be a problem with your eshop.", "source": "some-mergado-platform-app"}, "channels": ["frontend", "email"], "created_at": "2025-09-19T11:32:26+00:00"}, {"id": "29", "event": "project_enabled", "scope": "eshop", "priority": "system", "data": {"project_url": "http://app.mergado.com/projects/456/", "project_name": "Heureka.cz - produktový [CZ]", "user_name": "Freddy Krueger", "shop_name": "My Lovely Shop", "shop_url": "http://app.mergado.com/eshops/123/"}, "channels": ["frontend"], "created_at": "2025-09-05T10:36:42+00:00"}], "limit": 10, "total_results": 2, "offset": 0}}}, "schema": {"type": "object", "properties": {"data": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "event": {"type": "string"}, "scope": {"type": "string"}, "priority": {"type": "string"}, "data": {"type": "object"}, "channels": {"type": "array", "items": {"type": "string"}}, "created_at": {"type": "string"}}}}, "limit": {"type": "number"}, "total_results": {"type": "number"}, "offset": {"type": "number"}}}}}, "description": "Created", "headers": {}}}, "tags": ["Notifications"], "description": "**OAuth2 Scope:** `user.notify.read`\n\n**GET** `https://api.mergado.com/users/user_identifier/notifications/?limit=&filter=&offset=&fields=`\n\n- Examples of filtering by `created_at`:\n - Older than `2025-09-05` _(not including)_:\n ```\n ?filter=[{\"field\":\"created_at\",\"op\":\"<\",\"value\":\"2025-09-05\"}]'\n ```\n - Newer than `2025-09-05` _(including)_:\n ```\n ?filter=[{\"field\":\"created_at\",\"op\":\">\",\"value\":\"2025-09-05\"}]'\n ```\n - Between `2025-09-05` _(including)_ and `2025-10-02` _(not including the whole day of `2025-10-02`)_:\n ```\n ?filter=[{\"field\":\"created_at\",\"op\":\">\",\"value\":\"2025-09-05\"},{\"field\":\"created_at\",\"op\":\"<\",\"value\":\"2025-10-02\"}]'\n ```\n - Between `2025-09-05` _(including)_ and `2025-10-02 23:59:59` _(including the whole day of `2025-10-02`)_:\n ```\n ?filter=[{\"field\":\"created_at\",\"op\":\">\",\"value\":\"2025-09-05\"},{\"field\":\"created_at\",\"op\":\"<=\",\"value\":\"2025-10-02 23:59:59\"}]'\n ... or\n ?filter=[{\"field\":\"created_at\",\"op\":\">\",\"value\":\"2025-09-05\"},{\"field\":\"created_at\",\"op\":\"<\",\"value\":\"2025-10-03\"}]'\n ```", "summary": "Get user's notifications"}, "post": {"parameters": [{"description": "ID or username of a user.", "in": "path", "name": "user_identifier", "required": true, "schema": {"type": "string"}}], "responses": {"201": {"description": "Created", "headers": {"Location": {"schema": {"type": "string"}}}}}, "tags": ["Notifications"], "description": "**OAuth2 Scope:** user.notify.write. **POST** `https://api.mergado.com/users/user_identifier/notifications/`", "requestBody": {"content": {"application/json": {"schema": {"example": {"body": "Your settings has been updated.", "channels": ["frontend"], "priority": "high", "title": "User settings change"}, "properties": {"body": {"type": "string"}, "channels": {"items": {"type": "string"}, "type": "array"}, "priority": {"type": "string"}, "title": {"type": "string"}}, "type": "object"}}}}, "summary": "Notify a User"}}, "/users/{user_identifier}/permissions/": {"get": {"parameters": [{"description": "ID or username of a user.", "in": "path", "name": "user_identifier", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"role": "writer", "shop_id": "1"}, {"role": "writer", "shop_id": "10"}], "limit": 10, "offset": 0, "total_results": 2}}}, "schema": {"properties": {"role": {"description": "User's role.", "enum": ["writer", "reader"], "type": "string"}, "shop_id": {"description": "ID of the shop the role relates to.", "type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Users"], "description": "Lists all permissions (accesses to eshops) of a specific user.\n\n**OAuth2 Scope:** `user.shops.read`\n\n\n**GET** `https://api.mergado.com/users/user_identifier/permissions/` ", "summary": "Get User Permissions"}}, "/users/{user_identifier}/permissions/eshop/{eshopId}": {"get": {"parameters": [{"description": "ID or username of a user.", "in": "path", "name": "user_identifier", "required": true, "schema": {"type": "string"}}, {"description": "ID of a eshop.", "in": "path", "name": "eshopId", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"role": "writer", "shop_id": "14", "user_id": "2"}}}, "schema": {"properties": {"role": {"description": "User's role.", "enum": ["writer", "reader", "null"], "type": "string"}, "shop_id": {"description": "ID of the shop the role relates to.", "type": "string"}, "user_id": {"description": "ID of the user the role relates to.", "type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Users"], "description": "Returns user permission to given eshop.\n\n**OAuth2 Scope:** `user.read`\n\n**GET** `https://api.mergado.com/users/user_identifier/permissions/eshop/eshopId` ", "summary": "Get User Eshop Permissions"}}, "/users/{user_identifier}/permissions/project/{projectId}": {"get": {"parameters": [{"description": "ID or username of a user.", "in": "path", "name": "user_identifier", "required": true, "schema": {"type": "string"}}, {"description": "ID of a project.", "in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"project_id": "14", "role": "writer", "user_id": "2"}}}, "schema": {"properties": {"project_id": {"description": "ID of the project the role relates to.", "type": "string"}, "role": {"description": "User's role.", "enum": ["writer", "reader", "null"], "type": "string"}, "user_id": {"description": "ID of the user the role relates to.", "type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Users"], "description": "Returns user permission to given project.\n\n**OAuth2 Scope:** `user.read`\n\n\n**GET** `https://api.mergado.com/users/user_identifier/permissions/project/projectId`", "summary": "Get User Project Permissions"}}, "/users/{user_identifier}/shops/": {"get": {"parameters": [{"description": "ID or username of a user.", "in": "path", "name": "user_identifier", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"data": [{"avatar_url": "https://app.mergado.com/upload/8787f44a7f7da538ded3d7fc8d6bf7f3.png", "created_at": "2015-11-04T12:31:18+00:00", "exported_items": 256, "id": "1", "name": "Example.com", "owner_id": "1", "permissions": [{"role": "reader", "user_id": "2"}], "tariff_id": "7", "tariff_validity": "2015-12-01T10:02:51+00:00", "web": "http://example.com/", "xml_domain": "example.com"}], "limit": 10, "offset": 0, "total_results": 1}}}, "schema": {"example": {"data": [{"avatar_url": "https://app.mergado.com/upload/8787f44a7f7da538ded3d7fc8d6bf7f3.png", "created_at": "2015-11-04T12:31:18+00:00", "exported_items": 256, "id": "1", "name": "Example.com", "owner_id": "1", "permissions": [{"role": "reader", "user_id": "2"}], "tariff_id": "7", "tariff_validity": "2015-12-01T10:02:51+00:00", "web": "http://example.com/", "xml_domain": "example.com"}], "limit": 10, "offset": 0, "total_results": 1}, "properties": {"data": {"items": {"properties": {"avatar_url": {"type": "string"}, "created_at": {"type": "string"}, "exported_items": {"type": "number"}, "id": {"type": "string"}, "name": {"type": "string"}, "owner_id": {"type": "string"}, "permissions": {"items": {"properties": {"role": {"type": "string"}, "user_id": {"type": "string"}}, "type": "object"}, "type": "array"}, "tariff_id": {"type": "string"}, "tariff_validity": {"type": "string"}, "web": {"type": "string"}, "xml_domain": {"type": "string"}}, "type": "object"}, "type": "array"}, "limit": {"type": "number"}, "offset": {"type": "number"}, "total_results": {"type": "number"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Eshops"], "description": "Returns eshops the user can access.\n\n**OAuth2 Scope:** `user.shops.read`\n\n\n**GET** `https://api.mergado.com/users/user_identifier/shops/` ", "summary": "List User Eshops"}}, "/variables/{id}/": {"parameters": [{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "ID proměnné"}], "delete": {"responses": {"204": {"description": "No Content", "headers": {}}}, "tags": ["Variables"], "description": "Delete the specified variable.\n\n**OAuth2 Scope:** `project.variables.write`\n\n\n**Delete** `https://api.mergado.com/variables/id/` ", "summary": "Delete a Variable"}, "get": {"responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"element_path": "DESCRIPTION", "fragment_number": 2, "id": "1521", "name": "DESCRIPTION_A", "project_id": "33", "regular_expression": "(\\-|\\* )?(.*)", "sample_text": null, "type": "manual"}}}, "schema": {"example": {"element_path": "DESCRIPTION", "fragment_number": 2, "id": "1521", "name": "DESCRIPTION_A", "project_id": "33", "regular_expression": "(\\-|\\* )?(.*)", "sample_text": null, "type": "manual"}, "properties": {"element_path": {"type": "string"}, "fragment_number": {"type": "number"}, "id": {"type": "string"}, "name": {"type": "string"}, "project_id": {"type": "string"}, "regular_expression": {"type": "string"}, "sample_text": {"nullable": true}, "type": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {}}}, "tags": ["Variables"], "description": "Returns a variable.\n\n**OAuth2 Scope:** `project.variables.read`\n\n\n**GET** `https://api.mergado.com/variables/id/` ", "summary": "Get a Variable"}, "patch": {"parameters": [{"description": "ID of a variable.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"element_path": "DESCRIPTION", "fragment_number": 2, "id": "1521", "name": "DESCRIPTION_OMG", "project_id": "33", "regular_expression": "(\\-|\\* )?(.*)", "sample_text": null, "type": "manual"}}}, "schema": {"example": {"element_path": "DESCRIPTION", "fragment_number": 2, "id": "1521", "name": "DESCRIPTION_OMG", "project_id": "33", "regular_expression": "(\\-|\\* )?(.*)", "sample_text": null, "type": "manual"}, "properties": {"element_path": {"type": "string"}, "fragment_number": {"type": "number"}, "id": {"type": "string"}, "name": {"type": "string"}, "project_id": {"type": "string"}, "regular_expression": {"type": "string"}, "sample_text": {"nullable": true}, "type": {"type": "string"}}, "type": "object"}}}, "description": "OK", "headers": {"Location": {"schema": {"type": "string"}}}}}, "tags": ["Variables"], "description": "Performes update of variable's attributes.\n\n**OAuth2 Scope:** `project.variables.write`\n\n\n**PATCH** `https://api.mergado.com/variables/id/` ", "requestBody": {"content": {"application/json": {"schema": {"example": {"name": "DESCRIPTION_OMG"}, "properties": {"name": {"type": "string"}}, "type": "object"}}}}, "summary": "Update a Variable"}}}, "components": {"schemas": {"AccessCheckRequest": {"type": "object", "required": ["checks"], "properties": {"checks": {"type": "array", "items": {"$ref": "#/components/schemas/AccessCheckItem"}}}}, "AccessCheckItem": {"type": "object", "required": ["entity_type", "entity_id"], "properties": {"entity_type": {"type": "string", "enum": ["shop", "project"], "description": "Type of the entity to check access for."}, "entity_id": {"type": "integer", "description": "ID of the entity to check access for."}, "access": {"type": "string", "enum": ["read", "write"], "description": "Access level to check. If omitted, the maximum access level is determined."}}}, "AccessCheckResponse": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/AccessCheckResult"}}}}, "AccessCheckResult": {"type": "object", "properties": {"entity_type": {"type": "string", "enum": ["shop", "project"]}, "entity_id": {"type": "integer"}, "access": {"type": "string", "enum": ["read", "write"], "description": "The access level that was checked or determined."}, "allowed": {"type": "boolean", "description": "Whether the caller has the specified access to the entity."}}}, "App": {}, "Apps": {"type": "object", "properties": {"app_name": {"type": "string", "description": "Application's title."}, "free_until": {"type": "string", "description": "Datetime when application was created."}, "paid_until": {"type": "string", "description": "Datetime of application latest release."}, "title": {"type": "string", "description": "Application's title."}, "type": {"type": "string", "enum": ["user", "eshop", "project"], "description": "Type of the application."}, "creation_date": {"type": "string", "description": "Datetime when application was created."}, "trial_period": {"type": "number", "description": "How many days is application for free."}, "forum_url": {"type": "string", "description": "Application has it's own forum page."}, "latest_release_date": {"type": "string", "description": "Datetime of application latest release."}}}, "Audit_Issues": {"properties": {"info": {"description": "Additional info of the performed validation.", "properties": {}, "type": "object"}, "audit_id": {"description": "ID of the audit.", "type": "string"}, "checked_at": {"description": "When the validation was performed.", "type": "string"}, "feed_types": {"description": "List of formats or feed types the issue applies to.", "items": {}, "type": "array"}, "id": {"description": "ID of the issue.", "type": "string"}, "level": {"description": "Level of the importance of the issue.", "enum": ["recommendation", "warning", "error"], "type": "string"}, "product_id": {"description": "ID of the product (this is not a ID of the product\n\nin Mergado).", "type": "string"}, "validator": {"description": "A name identifying the performed validation.", "type": "string"}, "verdict": {"description": "Verdict of the performed validation.", "type": "string"}}, "type": "object"}, "Audit_Products": {"properties": {"audit_id": {"description": "ID of the audit.", "type": "string"}, "elements": {"description": "List of elements, values and subelements.", "items": {}, "type": "array"}, "id": {"description": "ID of the product.", "type": "string"}}, "type": "object"}, "Audited_Statistics": {"properties": {"date": {"description": "When the audit was performed.", "type": "string"}, "error": {"description": "Error raised during the process of\n\nperforming audit.", "type": "string"}, "finished_at": {"description": "When the audit was finished.", "type": "string"}, "id": {"description": "ID of the audit.", "type": "string"}, "issues": {"description": "Occurrences of issues in the audit.", "properties": {}, "type": "object"}, "product_count": {"description": "Number of products in the audit.", "type": "number"}, "started_at": {"description": "When the audit was started.", "type": "string"}, "status": {"description": "Status of the audit.", "enum": ["done", "in_progress", "error"], "type": "string"}}, "type": "object"}, "Audits": {"properties": {"date": {"description": "When the audit was performed.", "type": "string"}, "encoding": {"description": "Detected encoding.", "type": "string"}, "error": {"description": "Error raised during the process of\n\nperforming audit.", "type": "string"}, "expired_at": {"description": "Whether the audit expired, if yes than the date\n\nof expiration.", "type": "string"}, "feed_url": {"description": "URL of the XML feed.", "type": "string"}, "finished_at": {"description": "When the audit was finished.", "type": "string"}, "id": {"description": "ID of the audit.", "type": "string"}, "issues": {"description": "Occurrences of issues in the audit.", "properties": {}, "type": "object"}, "parser_type": {"description": "Parser used for parsing the XML feed.", "type": "string"}, "product_count": {"description": "Number of products in the audit.", "type": "number"}, "progress": {"description": "Progress of the audit (a number between 0 and 100).", "type": "number"}, "shop_name": {"description": "Detected eshop's name (is not 100% accurate).", "type": "string"}, "started_at": {"description": "When the audit was started.", "type": "string"}, "status": {"description": "Status of the audit.", "enum": ["done", "in_progress", "error"], "type": "string"}, "time": {"description": "Number of seconds the audit runs.", "type": "string"}, "webhook_url": {"description": "URL to call when the audit is finished. body.", "type": "string"}}, "type": "object"}, "Billing": {"type": "object", "properties": {"user_identifier": {"description": "User identification number.", "type": "string"}, "currency": {"description": "Currency of all services and applications.", "type": "string"}, "total_current_price": {"description": "Price which will appear in invoice.", "type": "number"}, "total_retail_price": {"description": "Standard price of services or applications.", "type": "number"}, "apps": {"type": "object", "properties": {"currency": {"type": "string"}, "total_current_price": {"type": "number"}, "total_retail_price": {"type": "number"}, "apps": {"type": "array", "items": {"type": "object", "properties": {"app_name": {"type": "string"}}}}}}, "services": {"type": "object", "properties": {"currency": {"type": "string"}, "total_current_price": {"type": "number"}, "total_retail_price": {"type": "number"}, "shops": {"type": "array", "items": {"type": "object", "properties": {"shop_id": {"type": "string"}}}}}}}, "example": {"user_identifier": "123", "currency": "CZK", "total_current_price": 1500, "apps": {"apps": [{"app_name": "application"}], "currency": "CZK", "total_current_price": 500}}}, "Category_Statistics": {"properties": {"categorytext": {"description": "Value of the element `CATEGORYTEXT`.", "type": "string"}, "date": {"description": "Date of the collection of the statistics.", "type": "string"}, "paired_products": {"description": "Number of products correctly paired on Heureka\n\nwith the given value of `CATEGORYTEXT`.", "type": "number"}, "unpaired_products": {"description": "Number of products incorrectly paired on Heureka\n\nwith the given value of `CATEGORYTEXT`.", "type": "number"}}, "type": "object"}, "Elements": {"properties": {"hidden": {"description": "Whether the product is hidden or not. Elements\n\ncan be hidden by a user or a hiding rule.", "type": "boolean"}, "id": {"description": "ID of the element.", "type": "string"}, "name": {"description": "Name of the element.", "type": "string"}, "project_id": {"description": "ID of the project in which the element created.", "type": "string"}, "type": {"description": "Type of the element.", "enum": ["input", "manual", "from_rule", "special"], "type": "string"}}, "type": "object"}, "Enabled_Apps": {"properties": {"app_name": {"description": "Name (ID) of the enabled app.", "type": "string"}, "free_until": {"description": "Trial expiration date.", "type": "string"}, "paid_until": {"description": "Paid subscription expiration date.", "type": "string"}}, "type": "object"}, "Eshop-rychle_API_Proxy": {"properties": {"id": {"description": "Eshop id.", "type": "string"}, "password": {"description": "Required query parameter", "type": "string"}, "path": {"description": "Fixed, required value: \"request.php\"", "type": "string"}}, "type": "object"}, "Eshop_Statistics": {}, "Eshops": {"properties": {"created_at": {"description": "Datetime when the export was created.", "type": "string"}, "exported_items": {"description": "Sum of exported items in all exports.", "type": "number"}, "id": {"description": "ID of the shop.", "type": "string"}, "name": {"description": "Unique name of the eshop.", "type": "string"}, "owner_id": {"description": "ID of the user who is the owner of the shop in Mergado\n\n(that is usualy the user who created the eshop).", "type": "string"}, "permissions": {"description": "List of users and roles with access to the eshop.", "type": "string"}, "tariff_id": {"description": "ID of the tariff the eshop has ordered.", "type": "string"}, "tariff_validity": {"description": "Datetime when the tariff expires.", "type": "string"}, "web": {"description": "Web sites of the eshop.", "type": "string"}, "xml_domain": {"description": "XML domain of the eshop as detected from an XML feed.", "type": "string"}}, "type": "object"}, "Google_Analytics_4": {"properties": {"clicks_sum": {"description": "Number of clicks of all products in the group taken from official metric `sessions`.", "type": "number"}, "group": {"description": "Values of the requested dimensions for the group.", "properties": {"date": {"description": "Groups each product by the date the product has been collected.", "type": "string"}, "day_of_week": {"description": "Groups the products by the day of the week.", "type": "number"}}, "type": "object"}, "orders_sum": {"description": "Number of orders of all products in the group taken from official metric `ecommercePurchases`.", "type": "number"}, "sales_sum": {"description": "Total sales of all products in the group taken from official metric `itemRevenue`.", "type": "number"}}, "type": "object"}, "Google_Merchant_API_Proxy": {"properties": {"id": {"description": "Eshop id.", "type": "integer"}, "path": {"description": "Uses Google Merchant API endpoints. Base URL: https://merchantapi.googleapis.com/", "type": "string"}}, "type": "object"}, "Heureka_API_Proxy": {"properties": {"id": {"description": "Eshop id.", "type": "string"}, "path": {"description": "Relativ path according to Heureka documentation. For example you can use as path `\"v1/reports/conversions\"` which will allow you to access Heureka's conversion reports", "type": "string"}}, "type": "object"}, "Heureka_Categories": {"properties": {"children": {"description": "Sub-categories of the category.", "items": {}, "type": "array"}, "full_name": {"description": "Full name of the category.", "type": "string"}, "heureka_id": {"description": "ID of the category in Heureka.", "type": "string"}, "id": {"description": "ID of the category.", "type": "string"}, "min_cpcs": {"description": "List of CPC values that apply to all children of the category unless explicitely\n\nspecified by the child.\n\n+ (object)\n + to_price (float) - Max price of the product in the category.\n + value (float) - Min CPC for the product given its price.", "items": {}, "type": "array"}, "name": {"description": "Name of the category.", "type": "string"}, "parent": {"description": "Parent of the category.", "properties": {"id": {"description": "ID of the parent.", "type": "string"}, "name": {"description": "Name of the parent.", "type": "string"}}, "type": "object"}}, "type": "object"}, "Info": {}, "Logs": {}, "Logs_of_the_Import_of_Statistics": {}, "Maintenance": {}, "Notifications": {}, "Pairings": {"properties": {"created_at": {"description": "The time the product was first seen in Mergado.\n\nNote that this field's value is a `null` for all products first seen\nbefore the date January 11, 2017.", "type": "string"}, "deleted_at": {"description": "The time when the product last appeared in the XML feed.", "type": "string"}, "id": {"description": "ID of the pairings. Values correspond to products IDs.", "type": "string"}}, "type": "object"}, "Product_Statistics": {"properties": {"date": {"description": "Date of collection of the statistics.", "type": "string"}, "product_id": {"description": "ID of the product.", "type": "string"}, "stats": {"description": "The statistics.", "properties": {"heureka_actual_cpc": {"description": "Value of cpc element in sortiment report.", "type": "number"}, "heureka_avg_position": {"description": "Average bidding position of the product\n\non Heureka. Unfortunately this is not very reliable information as\nthe average is taken only from all actual clicks on the product.\nAlso the product must be very popular, otherwise the information is\ncompletely missing.", "type": "number"}, "heureka_card_name": {"description": "Name of the product shown on Heureka.", "type": "string"}, "heureka_category": {"description": "Name of category Heureka paired this product into.", "type": "string"}, "heureka_categorytext": {"description": "Value of the `CATEGORYTEXT` element.", "type": "string"}, "heureka_clicks": {"description": "Number of clicks on the product\n\noffered by this eshop on Heureka.", "type": "number"}, "heureka_cost_of_sales": {"description": "Cost of sales for the product\n\non Heureka.", "type": "number"}, "heureka_cpc": {"description": "Paid costs per click for the product\n\non Heureka.", "type": "number"}, "heureka_delivery_date": {"description": "Delivery date set by the eshop.", "type": "string"}, "heureka_feed_cpc": {"description": "Offered cost per click to Heureka by the eshop.", "type": "number"}, "heureka_id": {"description": "Product id from sortiment report", "type": "string"}, "heureka_imgurl": {"description": "URL of the product's image.", "type": "string"}, "heureka_manufacturer": {"description": "Manufacturer of the product set by the eshop.", "type": "string"}, "heureka_max_prices": {"description": "Ordered list of maximal prices of the\n\nproduct offered by other eshops.", "items": {}, "type": "array"}, "heureka_min_cpc": {"description": "The minimal CPC Heureka accepts for the\n\nproduct.", "type": "number"}, "heureka_min_price": {"description": "Minimal offered price for the product\n\nfrom all eshops.", "type": "number"}, "heureka_min_prices": {"description": "Ordered list of minimal prices of the\n\nproduct offered by other eshops.", "items": {}, "type": "array"}, "heureka_name": {"description": "Name of the product in eshop.", "type": "string"}, "heureka_popularity": {"description": "Popularity of the product on Heureka.\n\nThe bigger, the more popular. There is no maximal popularity of\nproduct since Heureka doesn't provide such information.", "type": "number"}, "heureka_price_position": {"description": "Position of the product on by price\n\non Heureka.", "type": "number"}, "heureka_price_vat": {"description": "Price (with VAT included) of the product.", "type": "number"}, "heureka_sales": {"description": "Sales from the product on Heureka.", "type": "number"}, "heureka_segment": {"description": "The name of the section on Heureka the\n\nproduct was paired into.", "type": "string"}, "heureka_shop_url": {"description": "URL of the product in eshop.", "type": "string"}, "heureka_shops_count": {"description": "Number of eshops that offer the same\n\nproduct on Heureka.", "type": "number"}, "heureka_total_cost": {"description": "the product on Heureka.", "type": "number"}, "heureka_total_orders": {"description": "Number of total orders of\n\nthis product on Heureka.", "type": "number"}, "heureka_url": {"description": "URL of the product on Heureka.", "type": "string"}, "item_id (string) - ITEM_ID of the product.": {"type": "string"}, "mergado_cost": {"description": "How much the eshop had to pay for the product.", "type": "number"}, "mergado_is_starter": {"description": "This indicates whether the product is something\n\nyou usually buy with something else. Or to put it differently, let's\nsay you buy the body of a DLSR (e.g. Nikon D5200) than it is very\nlikely you also buy a lens or a tripod. This is indicated by this\nattribute. Unfortunately at the moment no eshop provides this information.", "type": "boolean"}, "mergado_is_topseller": {"description": "Whether the product is one of the most\n\nselling products in the eshop.", "type": "boolean"}, "zbozi_avg_position_product_detail": {"type": "number"}, "zbozi_avg_position_top_product_detail": {"type": "number"}, "zbozi_bid_click_through": {"type": "number"}, "zbozi_bid_click_through_category_listing": {"type": "number"}, "zbozi_bid_click_through_category_search": {"type": "number"}, "zbozi_bid_click_through_product_detail": {"type": "number"}, "zbozi_bid_click_through_search_result": {"type": "number"}, "zbozi_bid_click_through_top_product_detail": {"type": "number"}, "zbozi_brand": {"type": "string"}, "zbozi_card_name": {"type": "string"}, "zbozi_categorytext": {"type": "string"}, "zbozi_conversion_cost_czk": {"type": "number"}, "zbozi_conversion_cost_czk_category_listing": {"type": "number"}, "zbozi_conversion_cost_czk_category_search": {"type": "number"}, "zbozi_conversion_cost_czk_product_detail": {"type": "number"}, "zbozi_conversion_cost_czk_search_result": {"type": "number"}, "zbozi_conversion_cost_czk_top_product_detail": {"type": "number"}, "zbozi_conversion_rate": {"type": "number"}, "zbozi_conversion_rate_category_listing": {"type": "number"}, "zbozi_conversion_rate_category_search": {"type": "number"}, "zbozi_conversion_rate_product_detail": {"type": "number"}, "zbozi_conversion_rate_search_result": {"type": "number"}, "zbozi_conversion_rate_top_product_detail": {"type": "number"}, "zbozi_conversions": {"type": "number"}, "zbozi_conversions_category_listing": {"type": "number"}, "zbozi_conversions_category_search": {"type": "number"}, "zbozi_conversions_product_detail": {"type": "number"}, "zbozi_conversions_search_result": {"type": "number"}, "zbozi_conversions_top_product_detail": {"type": "number"}, "zbozi_conversions_value_czk": {"type": "number"}, "zbozi_conversions_value_czk_category_listing": {"type": "number"}, "zbozi_conversions_value_czk_category_search": {"type": "number"}, "zbozi_conversions_value_czk_product_detail": {"type": "number"}, "zbozi_conversions_value_czk_search_result": {"type": "number"}, "zbozi_conversions_value_czk_top_product_detail": {"type": "number"}, "zbozi_cpc_czk_category_listing": {"type": "number"}, "zbozi_cpc_czk_category_search": {"type": "number"}, "zbozi_cpc_czk_product_detail": {"type": "number"}, "zbozi_cpc_czk_search_result": {"type": "number"}, "zbozi_cpc_czk_top_product_detail": {"type": "number"}, "zbozi_cpc_czk_vat_category_listing": {"type": "number"}, "zbozi_cpc_czk_vat_category_search": {"type": "number"}, "zbozi_cpc_czk_vat_product_detail": {"type": "number"}, "zbozi_cpc_czk_vat_search_result": {"type": "number"}, "zbozi_cpc_czk_vat_top_product_detail": {"type": "number"}, "zbozi_cpr": {"type": "number"}, "zbozi_cpr_category_listing": {"type": "number"}, "zbozi_cpr_category_search": {"type": "number"}, "zbozi_cpr_product_detail": {"type": "number"}, "zbozi_cpr_search_result": {"type": "number"}, "zbozi_cpr_top_product_detail": {"type": "number"}, "zbozi_delivery_date": {"type": "number"}, "zbozi_direct_conversions": {"type": "number"}, "zbozi_id": {"type": "string"}, "zbozi_imgurl": {"type": "string"}, "zbozi_last_known_category": {"type": "string"}, "zbozi_manufacturer": {"type": "string"}, "zbozi_max_cpc": {"type": "number"}, "zbozi_max_cpc_search": {"type": "number"}, "zbozi_name": {"type": "string"}, "zbozi_price_vat": {"type": "number"}, "zbozi_products_sold_through_zbozi": {"type": "number"}, "zbozi_shop_url": {"type": "string"}, "zbozi_views_category_listing": {"type": "number"}, "zbozi_views_category_search": {"type": "number"}, "zbozi_views_product_detail": {"type": "number"}, "zbozi_views_search_results": {"type": "number"}, "zbozi_views_top_product_detail": {"type": "number"}}, "type": "object"}}, "type": "object"}, "Products": {"properties": {"data": {"description": "Output data of this product.", "type": "string"}, "extracted_values": {"description": "Data extracted from element paths or\n\nvariables provided in values_to_extract parameter.", "type": "string"}, "id": {"description": "ID of the product. Values correspond to pairings IDs.", "type": "string"}, "input_data": {"description": "Input data of this product.", "type": "string"}, "output_changed_at": {"description": "The last time output data (values of elements)\n\nof this product changed.", "type": "string"}, "updated_at": {"description": "The last time input data of this product changed.", "type": "string"}}, "type": "object"}, "Projects": {"properties": {"all_products_query_id": {"description": "Id of the ♥ALLPRODUCTS♥ query.", "type": "string"}, "created": {"description": "When the project was created.", "type": "string"}, "creator_id": {"description": "ID of the user who created this project.", "type": "string"}, "data_synced_at": {"description": "The last time an input feed was imported.", "type": "string"}, "data_updated_at": {"description": "The last time the project was updated by a change in the input data feed.", "type": "string"}, "exported_items": {"description": "Number of exported items in the last export of the project.", "type": "number"}, "id": {"description": "ID of the project (or sometimes called export).", "type": "string"}, "in_testing_mode": {"description": "If the project is in testing mode, export is never performed.", "type": "boolean"}, "input_fomat": {"description": "Input format (e.g. heureka.cz, zbozi.cz).", "type": "string"}, "is_dirty": {"description": "Dirty project means that during the next rebuild of the project, all rules to\n\nall products will be applied.", "type": "boolean"}, "is_paused": {"description": "If the project is paused, automatic scheduled rebuilds are skipped.", "type": "boolean"}, "last_access": {"description": "Last access to the project by a user.", "type": "string"}, "metadata": {"description": "Additional data such as UTM params set by the user.", "properties": {}, "type": "object"}, "name": {"description": "Name of the project.", "type": "string"}, "number_of_elements": {"description": "Total number of defined elements.", "type": "number"}, "output_format": {"description": "Output format.", "type": "string"}, "pairing_elements": {"description": "List of pairing elements (used for sychronization of XML feed).", "type": "string"}, "readonly": {"description": "If the project is set to readonly it means that the project is currently\n\nbeing regenerated and therefore it is not possible to trigger another regeneration.\nProduct data available in the API may not be consistent with the data in the output feed", "type": "boolean"}, "rules_changed_at": {"description": "The last time someone created, deleted or updated a rule in the project.", "type": "string"}, "shop_id": {"description": "Eshop ID.", "type": "string"}, "slug": {"description": "Unique identifier used in output URL of the exported XML feed.", "type": "string"}, "sync_schedule": {"description": "Project synchronization data. Contains schedule settings (written in cron syntax).", "properties": {}, "type": "object"}, "turned_off": {"description": "Whether the project was turned off or not.", "type": "boolean"}, "update_period": {"description": "Update period of the project (how often to run import of the input XML feed).", "type": "number"}, "url": {"description": "URL of the XML feed with products.", "type": "string"}}, "type": "object"}, "Queries": {"properties": {"advanced_interface": {"description": "Whether the query was created using\n\nthe advanced interface. Advanced interface represents the raw [MQL](https://mergado.github.io/docs/apps/rules-and-queries.html) query.", "type": "string"}, "created_at": {"description": "When was the query created.", "type": "string"}, "id": {"description": "ID of the query.", "type": "string"}, "name": {"description": "Name of the query.", "type": "string"}, "product_count": {"description": "Number of products matching the query.", "type": "number"}, "project_id": {"description": "ID of the project the query is created in.", "type": "string"}, "query": {"description": "Raw [MQL](https://mergado.github.io/docs/apps/rules-and-queries.html) query.", "type": "string"}, "read_only": {"description": "Whether the query can be modified.", "type": "boolean"}, "search_output": {"description": "Whether the query should select products' data\n\naccording to the values of input data or output data.", "type": "boolean"}}, "type": "object"}, "Rule_Definitions": {"properties": {"fields": {"description": "List of fields the rule accepts during instantiation.", "type": "string"}, "relationship": {"description": "Whether the rule accepts an object\n\n(dictionary) as an argument or a list of objects.", "enum": ["1:1", "1:N"], "type": "string"}, "type": {"description": "Unique name of the rule.", "type": "string"}}, "type": "object"}, "Rules": {"properties": {"applies": {"description": "Whether the rule is turned on or off.", "type": "boolean"}, "data": {"description": "Parameters of the rule, some rules accept parameters, e.g.\n\na value to write into an element, regular expressions, etc.", "type": "string"}, "element_path": {"description": "Element path of the element the rule\n\nshould apply to. The element is optional, not all rules require an element.", "type": "string"}, "id": {"description": "ID of the rule.", "type": "string"}, "is_deletable": {"description": "Whether the user is allowed to delete the rule.", "type": "boolean"}, "is_editable": {"description": "Whether the user is allowed to edit the rule.", "type": "boolean"}, "is_movable": {"description": "Whether the user is allowed to change position\n\nthe rule.", "type": "boolean"}, "is_pausable": {"description": "Whether the user is allowed to pause the rule.", "type": "boolean"}, "name": {"description": "Name of the rule (is shown in Mergado UI). The maximum length is 100 characters and it cannot contain any special characters.", "type": "string"}, "priority": {"description": "Priority of the rule, or the position when it is applied.\n\nThe position matters as each rule makes some changes to the products' data.", "type": "number"}, "project_id": {"description": "ID of the project the rule was created in.", "type": "string"}, "queries": {"description": "It is possible to control to what products each rule applies.\n\nQueries exists for exactly this purpose.", "items": {}, "type": "array"}, "type": {"description": "Type of the rule.", "type": "string"}}, "type": "object"}, "Shopify_API_Proxy": {"properties": {"id": {"description": "Eshop id.", "type": "string"}, "path": {"description": "Uses Shopify's endpoints", "type": "string"}}, "type": "object"}, "Tariffs": {}, "UNAS_API_Proxy": {"properties": {"id": {"description": "Eshop id.", "type": "string"}, "path": {"description": "Uses UNAS's endpoints", "type": "string"}}, "type": "object"}, "User": {}, "Users": {"properties": {"avatars": {"description": "A dictionary containing dimensions (as keys) with URLs of avatars.", "type": "string"}, "city": {"description": "User's city.", "type": "string"}, "company": {"description": "User's company.", "type": "string"}, "country": {"description": "Country code in ISO 3166-1.", "type": "string"}, "dic": {"description": "VAT identification number.", "type": "string"}, "email": {"description": "User's email address.", "type": "string"}, "fakturoid_id": {"description": "ID for connection with [fakturoid.cz](https://fakturoid.cz).", "type": "string"}, "first_name": {"description": "User's first name.", "type": "string"}, "ico": {"description": "Taxpayer identification number.", "type": "string"}, "id": {"description": "User's ID.", "type": "string"}, "invoice_months": {"description": "Number of months to be invoiced for Mergado.", "type": "number"}, "invoicing_validity_date": {"description": "The date until which a user's services are prepaid.", "type": "string"}, "last_access": {"description": "Datetime of user's last access to Mergado.", "type": "string"}, "last_name": {"description": "User's last name.", "type": "string"}, "locale": {"description": "User's locale in ISO 15897.", "type": "string"}, "name": {"description": "User's full name.", "type": "string"}, "phone": {"description": "User's phone number.", "type": "string"}, "postcode": {"description": "User's postal code.", "type": "string"}, "registered_at": {"description": "Datetime of registration.", "type": "string"}, "send_summary": {"description": "Whether the user wants to receive a summary about their eshops/exports.", "type": "boolean"}, "street": {"description": "User's street.", "type": "string"}, "timezone": {"description": "User's timezone.", "type": "string"}, "timezone_offset": {"description": "Timezone offset.", "type": "string"}, "username": {"description": "User's login.", "type": "string"}}, "type": "object"}, "Variables": {"properties": {"element_path": {"description": "Element path of the element the variable is created from.", "type": "string"}, "fragment_number": {"description": "Fragment or group number to match\n\nfrom given regular expression.", "type": "number"}, "id": {"description": "ID of the variable.", "type": "string"}, "name": {"description": "Name of the variable.", "type": "string"}, "project_id": {"description": "ID of the project the variable is created in.", "type": "string"}, "regular_expression": {"description": "Regular expression used for\n\nparsing some part of an element's value (for example domain from URL).", "type": "string"}, "sample_text": {"description": "Sample text used for the regular\n\nexpression. This is visible in the UI so that a user can immediately\nsee the result of the regular expression.", "type": "string"}, "type": {"description": "Type of the variable, whether it was created\n\nautomatically as a pair to input elements, or manually by a user or in API.", "enum": ["input", "manual"], "type": "string"}}, "type": "object"}, "WooCommerce_API_Proxy": {"properties": {"id": {"description": "Eshop id.", "type": "string"}, "path": {"description": "Uses WooCommerce's endpoints", "type": "string"}}, "type": "object"}, "Sklik_API_Proxy": {"properties": {"id": {"description": "Eshop id.", "type": "string"}, "path": {"description": "Sklik Fenix API endpoint path.", "type": "string"}}, "type": "object"}, "XML_Formats": {}, "Zbozi_API_Proxy": {"properties": {"id": {"description": "Eshop id.", "type": "string"}, "path": {"description": "Base value: \"api.zbozi.cz\" followed by a Zbozi's endpoint", "type": "string"}}, "type": "object"}}}, "tags": [{"description": "Endpoints for checking caller access to entities (shops, projects). Supports dual access checks when using JWT tokens issued by the app proxy.", "name": "Access"}, {"description": "Transparent proxy for forwarding requests to registered apps. Generates JWT tokens with scope intersection and audience (`aud`) field for secure cross-app communication.", "name": "App Proxy"}, {"description": "Various API resources that don't require any authentication.", "name": "Base"}, {"description": "Information about yourself - current client accessing the API _(identified by access token)_.", "name": "Me"}, {"description": "\n**Description:**\nApplications in Mergado.", "name": "Apps"}, {"description": "\n**Description:**\nBilling is used for automatic invoicing via Fakturoid.", "name": "Billing"}, {"description": "Users with an account in Mergado.", "name": "Users"}, {"description": "Eshops in Mergado.", "name": "Eshops"}, {"description": "\nProject is created when a user imports an XML feed in Mergado. This feed may come in different formats and it is very common that one eshop has several projects each managed for a different shopping service.", "name": "Projects"}, {"description": "\n**Product Logic & Filtering:**\nA product represents one item currently present in an XML feed.\n* **Extracted Values:** If the `values_to_extract` parameter is provided, the response will include the `extracted_values` field. Otherwise, this field is omitted.\n* **MQL Filtering:** You can filter products using the `mql` parameter in a `GET` request. For complex queries that exceed URL limits, use a `POST` request with the `mql` value in the body.\n* **Visibility (is_hidden):** * `true` – Returns only hidden products.\n * `false` – Returns only non-hidden products.\n * `null` (or omitted) – Returns all products.", "name": "Products"}, {"description": "\nA pairing represents one item which has appeared at least once in an XML feed.", "name": "Pairings"}, {"description": "\nElements are named attributes of products.", "name": "Elements"}, {"description": "\nVariables can be seen as pointers to products' values or parts of values and can be used in most rules. \nVariables are created automatically during import and in the UI when an element is created. However, they can also be created by users who can use a regular expression to match only a part of a product's value (e.g., extracting a domain from a URL).", "name": "Variables"}, {"description": "\nRules are probably the most important feature in Mergado. They allow users to modify their XML feeds or convert a feed to a different format (e.g., from Heureka.cz to Google Merchant). \nAPI for rule management, definition, and application. Note that the order (priority) of rules is crucial as each rule modifies the data for the rules that follow.", "name": "Rules"}, {"description": "\nMQL query management.", "name": "Queries"}, {"description": "\n**Access & Security:**\nNotifications can only be read by access tokens bound to the specific user who is the recipient. This requires:\n* **Online token:** For user/e-shop/project Mergado platform apps. * **Offline token:** For user-bound Mergado platform apps.\n**Key Concepts:**\n* **Channel:** Represents the way to notify the users (e.g., email, UI). * **Scope:** Defines the target audience or reach of the notification. * **Priority:** Determines the importance and follows user-defined delivery rules.", "name": "Notifications"}, {"description": "\nCore actions like import, export, application of rules, or downloads by shopping services are logged separately. Note that each log entry is available only for 30 days.", "name": "Logs"}, {"description": "\nManagement of enabled apps by users.", "name": "Enabled Apps"}, {"description": "API for statistics collected from eshops, shopping services and other resources. **Warning:** Product and category statistics are currently collected only for `heureka.cz` and `heureka.sk`\nexport (project) formats. This means that Audits are also performed on stats from these services.", "name": "Statistics"}, {"description": "\nAn Audit represents a validation process of an XML feed. It checks for format correctness, missing attributes, and other common errors. \n**Webhook Integration:** If a `webhook_url` is provided, Mergado will send an asynchronous POST request with the results once the processing is complete. Audit of product feed.\n\n- Issues are checks with non-ok verdicts. Some issues are feed-wide, so\n they are bound only to an audit resource. Most issues are product-specific,\n so they are bound to audit and also to product resource.\n\n- Every validator provides specific additional info to check. It is accessible\n in `info` field of issues and it can have various forms - its schema is\n validator-dependent.\n\n- Web hook URL is requested with POST (audit's JSON resource sent in data)\n right in the moment when audit is finished.\n\n- Progress is raised by every check, there is no information about *total*\n number of progress units.\n\n- Feed type is optional. In case it's missing, it is detected before audit\n starts.\n\n- Error field of audits and issues has nothing to do with checking itself -\n is is used only in case mergado3 application fails and raises an exception.\n This generic error field is rather for debugging API than for being consumed\n by API clients.\n\n- Product's data is parsed and saved just *as is* into data field. No semantic\n analysis is performed, validators take it raw and do whatever they want\n with it. This means the data field also has no fixed schema.\n\n- Audits can be scheduled.", "name": "Feed Audits"}, {"description": "\n**Proxy Details:**\n\nHeureka provides an API for reports and statistics. At the moment it doesn’t offer a lot of features, but we expect more to be added over time. You can find more information about currently available endpoints at official documentation. \nThis endpoint works as a proxy. Some Heureka eshops can generate their own API key, which is then used for authentication. Mergado takes care of this step for you, the key is automatically added to the request header, so you don’t need to handle it manually. Apart from that, please follow the official documentation mentioned above regarding URL parameters, request bodies, and headers.\nNote that this endpoint for Heureka will only work if the /shops/{id}/info endpoint returns a valid Heureka connection with api_enabled: true.", "name": "Heureka API Proxy"}, {"description": "**Category Logic:**\n\nAPI for Heureka categories. Categories have a **min cpc** value attached to it, but not every category displays this value. If you want to find a **min cpc** value of a category, you need to traverse its parents until you find a category with **min cpc** displayed. This value then applies to all children categories.", "name": "Heureka Categories"}, {"description": "\n**Proxy Details:**\n\nThis endpoint works as a proxy. Eshop-rychle provides an orders API to retrieve information about shop's orders. \nYou can find more information about the API in the [official documentation](https://podpora.eshop-rychle.cz/api-dokumentace/).", "name": "Eshop-rychle"}, {"description": "\n\n**Proxy Details:**\n\n This endpoint works as a proxy. The API is available to e-shops which use Zboží.cz and fulfill API access conditions. The API is a RESTful JSON API and uses HTTPS protocol only. \n \n **Important Note:** Methods `GET /v1/shop/bidding-info` and `GET /v1/shop/campaign/current` are no longer available for shops that have been transferred to the Sklik advertising system. Please refer to the Sklik API documentation. \n \n You can find more information about the API in the [official documentation](https://napoveda.sklik.cz/zbozi/api/).", "name": "Zbozi"}, {"description": "\n**Proxy Details:**\n\nThis endpoint works as a proxy. The API is available to e-shops which use WooCommerce and fulfill API access conditions. \nThe API is a RESTful JSON API. You can find more information about the API in the [official documentation](https://woocommerce.github.io/woocommerce-rest-api-docs/).", "name": "WooCommerce"}, {"description": "\n**Proxy Details:**\n\nThis endpoint works as a proxy. The API is available to e-shops which use Shopify and fulfill API access conditions. \nThe API supports the legacy **REST Admin API**, and also the **GraphQL API**. You can find more information in the official Shopify documentation.", "name": "Shopify"}, {"description": "\nStatistics for products grouped by specific dimensions from Google Analytics 4 (GA4).", "name": "Google Analytics 4"}, {"name": "Google Merchant", "description": "The API is available to e-shops which use Google Merchant and fulfill API access conditions. The API is a RESTful JSON API. You can find more information about the API in the official documentation. This endpoint works as a proxy."}, {"description": "\n**Proxy Details:**\n\nThis endpoint works as a proxy. UNAS offers a comprehensive API that enables reading and modifying key e-shop data — including orders, products, customers, shipping options, and reviews. \nThis endpoint serves as a proxy for communication with the official UNAS API.", "name": "UNAS"}, {"description": "\n\nThe API is available to e-shops which use Sklik Fenix and fulfill API access conditions. The API is a RESTful JSON API. You can find more information about the API in the official documentation.This endpoint works as a proxy.", "name": "Sklik - Fenix"}]}