openapi-directory/api/beezup.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"email":"help@beezup.com"},"description":"# The REST API of BeezUP system\n## Overview\nThe REST APIs provide programmatic access to read and write BeezUP data. \nBasically, with this API you will be able to do everything like you were with your browser on https://go.beezup.com !\n\nThe main features are:\n- Register and manage your account\n- Create and manage and share your stores with your friends/co-workers.\n- Import your product catalog and schedule the auto importation\n- Search the channels your want to use\n- Configure your channels for your catalogs to export your product information:\n    - cost and general settings\n    - category and columns mappings\n    - your will be able to create and manage your custom column\n    - put in place exlusion filters based on simple conditions on your product data\n    - override product values\n    - get product vision for a channel catalog scope\n- Analyze and optimize your performance of your catalogs on all yours channels with different type of reportings by day, channel, category and by product.\n- Automatize your optimisation by using rules!\n- And of course... Manage your orders harvested from all your marketplaces:\n    - Synchronize your orders in an uniformized way\n    - Get the available actions and update the order status\n- ...and more!\n\n## Authentication credentials\nThe public API with the base path **/v2/public** have been put in place to give you an entry point to our system for the user registration, login and lost password. The public API does not require any credentials.\nWe give you the some public list of values and public channels for our public commercial web site [www.beezup.com](http://www.beezup.com).\n\nThe user API with the base path **/v2/user** requires a token which is available on this page:\nhttps://go.beezup.com/Account/MyAccount\n\n## Things to keep in mind\n### API Rate Limits\n- The BeezUP REST API is limited to 100 calls/minute.\n\n### Media type\nThe default media type for requests and responses is application/json. Where noted, some operations support other content types. If no additional content type is mentioned for a specific operation, then the media type is application/json.\n\n### Required content type\nThe required and default encoding for the request and responses is UTF8.\n\n### Required date time format\nAll our date time are formatted in ISO 8601 format: 2014-06-24T16:25:00Z.\n\n### Base URL\nThe Base URL of the BeezUP API Order Management REST API conforms to the following template.\n\nhttps://api.beezup.com\n\nAll URLs returned by the BeezUP API are relative to this base URL, and all requests to the REST API must use this base URL template.\n\nYou can test our API on https://api-docs.beezup.com/swagger-ui\\\nYou can contact us on [gitter, #BeezUP/API](https://gitter.im/BeezUP/API)\n","license":{"name":"BeezUP","url":"http://www.beezup.com"},"title":"BeezUP","version":"2.0","x-apisguru-categories":["ecommerce"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://avatars0.githubusercontent.com/u/25665430"},"x-origin":[{"format":"swagger","url":"https://api-docs.beezup.com/swagger.json","version":"2.0"}],"x-providerName":"beezup.com"},"externalDocs":{"description":"Find the documentation for BeezUP's API here","url":"https://api-docs.beezup.com/"},"tags":[{"name":"Public - Security - Security","x-displayName":"Security"},{"description":"All our public channels operations","name":"Public - Channels - Public Channels","x-displayName":"Public Channels"},{"description":"All LOV operations","name":"Public - List of Values - LOV","x-displayName":"LOV"},{"description":"All LOV operations","name":"User - List of Values - LOV","x-displayName":"LOV"},{"description":"All global operations","name":"Customer - Global","x-displayName":"Global"},{"description":"All user account operations","name":"Customer - Account","x-displayName":"Account"},{"description":"All security operations","name":"Customer - Security","x-displayName":"Security"},{"description":"All stores operations","name":"Customer - Stores","x-displayName":"Stores"},{"description":"All store share operations","name":"Customer - Shares","x-displayName":"Shares"},{"description":"All stores' alerts operations","name":"Customer - Alerts","x-displayName":"Alerts"},{"description":"All store rights operations","name":"Customer - Rights","x-displayName":"Rights"},{"description":"All friends operations","name":"Customer - Friends","x-displayName":"Friends"},{"description":"All contracts and offer operations","name":"Customer - Contracts","x-displayName":"Contracts"},{"description":"All invoice operations","name":"Customer - Invoices","x-displayName":"Invoices"},{"description":"All operations related to the Auto importation","name":"Catalogs - Auto","x-displayName":"Auto"},{"description":"All operations related to global information","name":"Catalogs - Global","x-displayName":"Global"},{"description":"All operations concerning the importation process","name":"Catalogs - Importation Process","x-displayName":"Importation Process"},{"description":"All operations related to the catalog information during the importation","name":"Catalogs - Importation Catalog Info","x-displayName":"Importation Catalog Info"},{"description":"All operation related to the catalog","name":"Catalogs - Catalog","x-displayName":"Catalog"},{"description":"All global operations","name":"Channels - Channels Global","x-displayName":"Channels Global"},{"description":"All global operations","name":"Channel Catalogs - Global","x-displayName":"Global"},{"description":"All settings operations","name":"Channel Catalogs - Settings","x-displayName":"Settings"},{"description":"All column mapping operations","name":"Channel Catalogs - Column Mappings","x-displayName":"Column Mappings"},{"description":"All categories operations","name":"Channel Catalogs - Categories","x-displayName":"Categories"},{"description":"All exclusion filters operations","name":"Channel Catalogs - Exclusion Filters","x-displayName":"Exclusion Filters"},{"description":"All products operations","name":"Channel Catalogs - Products","x-displayName":"Products"},{"description":"All products overrides operations","name":"Channel Catalogs - Products Overrides","x-displayName":"Products Overrides"},{"description":"All products optimisation operations","name":"Channel Catalogs - Products Optimisation","x-displayName":"Products Optimisation"},{"description":"All channel catalog exportation operations","name":"Channel Catalogs - Exportations","x-displayName":"Exportations"},{"description":"Operations to fetch your marketplace account related to your channel catalogs","name":"Marketplaces - Channel catalogs - Global","x-displayName":"Global"},{"description":"Operations to fetch your marketplace account's catalog publication history","name":"Marketplaces - Channel catalogs - Publications","x-displayName":"Publications"},{"description":"Operations to manage your channel catalogs' marketplace settings","name":"Marketplaces - Channel catalogs - Settings","x-displayName":"Settings"},{"description":"All global operations (cross marketplace)","name":"Marketplaces - Orders - Global","x-displayName":"Global"},{"description":"All auto transitions operations","name":"Marketplaces - Orders - AutoTransitions","x-displayName":"AutoTransitions"},{"description":"All Order list operations","name":"Marketplaces - Orders - List","x-displayName":"List"},{"description":"All operations related to a single Order","name":"Marketplaces - Orders - Order","x-displayName":"Order"},{"description":"All batch operations on Orders to reduce call rate","name":"Marketplaces - Orders - Batches","x-displayName":"Batches"},{"description":"All Order report exportation operations","name":"Marketplaces - Orders - Exports","x-displayName":"Exports"},{"description":"All global operations concerning Analytics API","name":"Analytics - Global","x-displayName":"Global"},{"description":"All tracking operations","name":"Analytics - Tracking","x-displayName":"Tracking"},{"description":"All statitics operations","name":"Analytics - Statistics","x-displayName":"Statistics"},{"description":"All optmisations operations","name":"Analytics - Optimisations","x-displayName":"Optimisations"},{"description":"All reports operations","name":"Analytics - Reports","x-displayName":"Reports"},{"description":"All rules operations. Rules are automatic optimisations based on report filters","name":"Analytics - Rules","x-displayName":"Rules"}],"paths":{"/public/channels/":{"get":{"description":"Use this operation to get the correct link to the channels and to the list of values","operationId":"GetChannelsIndex","parameters":[{"$ref":"#/components/parameters/ifNoneMatchParameter"}],"responses":{"200":{"description":"Channel list regrouped by country and links to list of values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicChannelIndex"}}}},"304":{"$ref":"#/components/responses/304_NotModified"},"default":{"$ref":"#/components/responses/GeneralError"}},"summary":"Get public channel index","tags":["Public - Channels - Public Channels"]}},"/public/channels/{countryIsoCode}":{"get":{"operationId":"GetChannels","parameters":[{"description":"The country iso code alpha 3 based on this: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Decoding_table \\\nTo know which country are available you have to use the operation: GetChannelsByCountry\n","in":"path","name":"countryIsoCode","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/acceptEncodingRequiredParameter"},{"$ref":"#/components/parameters/ifNoneMatchParameter"}],"responses":{"200":{"description":"The channel list for one country","content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelInfoList"},"examples":{"response":{"value":{"channels":[{"homeUrl":"http://www.amazon.fr","logoUrl":"http://beezupcdn.blob.core.windows.net/comparators/Amazon%2520Direct%2520FRA.png","name":"Amazon Direct FRA","types":["Marketplace"]}]}}}}}},"304":{"$ref":"#/components/responses/304_NotModified"},"404":{"description":"Channel country not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"summary":"The channel list for one country","tags":["Public - Channels - Public Channels"]}},"/public/lov/":{"get":{"operationId":"GetPublicLovIndex","parameters":[{"$ref":"#/components/parameters/ifNoneMatchParameter"}],"responses":{"200":{"description":"Get the list names","headers":{"Cache-Control":{"description":"Indicates the directive around the caching mechanisms.\\\nFor more information, please go to this link: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9\n","schema":{"type":"array","items":{"type":"string"}},"style":"simple"},"ETag":{"description":"The ETag corresponding to the LOV Index","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicLovIndex"}}}},"304":{"description":"The ETag sent in the http header If-None-Match did not change. So you can keep your version.","headers":{"Cache-Control":{"description":"Indicates the directive around the caching mechanisms.\\\nFor more information, please go to this link: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9\n","schema":{"type":"array","items":{"type":"string"}},"style":"simple"},"ETag":{"description":"The ETag corresponding to the LOV Index","schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"summary":"Get all list names","tags":["Public - List of Values - LOV"]}},"/public/lov/{listName}":{"get":{"operationId":"GetPublicListOfValues","parameters":[{"description":"The list of value name your want to get","in":"path","name":"listName","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/acceptLanguageParameter"},{"$ref":"#/components/parameters/ifNoneMatchParameter"}],"responses":{"200":{"description":"The list of values","headers":{"Cache-Control":{"description":"Indicates the directive around the caching mechanisms.\\\nFor more information, please go to this link: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9\n","schema":{"type":"array","items":{"type":"string"}},"style":"simple"},"Content-Language":{"description":"Indicates the language use in the response","schema":{"type":"array","items":{"type":"string"}},"style":"simple"},"ETag":{"description":"The ETag corresponding to the LOV Index","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicListOfValuesResponse"}}}},"304":{"description":"The ETag sent in the http header If-None-Match did not change. So you can keep your version.","headers":{"Cache-Control":{"description":"Indicates the directive around the caching mechanisms.\\\nFor more information, please go to this link: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9\n","schema":{"type":"array","items":{"type":"string"}},"style":"simple"},"ETag":{"description":"The ETag corresponding to the LOV Index","schema":{"type":"string"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"summary":"Get the list of values related to this list name","tags":["Public - List of Values - LOV"]}},"/public/security/login":{"post":{"description":"User Login - The login will give your tokens","operationId":"Login","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/loginRequest"}}},"required":true},"responses":{"200":{"description":"Your tokens","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiCredentials"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"403":{"description":"Invalid credentials"},"500":{"$ref":"#/components/responses/GeneralError"}},"summary":"Login","tags":["Public - Security - Security"]}},"/public/security/lostpassword":{"post":{"description":"Lost password - Your password will be regenerated and sent to your email","operationId":"LostPassword","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.Email"}}},"description":"Your email","required":true},"responses":{"204":{"description":"New password sent"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"404":{"description":"Email not found"},"500":{"$ref":"#/components/responses/GeneralError"},"502":{"description":"Problem with SMTP service","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}}},"summary":"Lost password","tags":["Public - Security - Security"]}},"/public/security/register":{"post":{"description":"User Registration - Create a new user on BeezUP","operationId":"Register","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/registerRequest"}}},"required":true},"responses":{"204":{"description":"Customer registered"},"400":{"description":"Email or password is invalid. Disposable email are refused."},"409":{"description":"Email already used"},"500":{"$ref":"#/components/responses/GeneralError"}},"summary":"User Registration","tags":["Public - Security - Security"]}},"/user/analytics/":{"get":{"operationId":"AnalyticsIndex","responses":{"200":{"description":"Analytics API operation index","content":{"application/json":{"schema":{"$ref":"#/components/schemas/analyticsIndex"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the Analytics API operation index","tags":["Analytics - Global"]}},"/user/analytics/tracking/status":{"get":{"description":"Clicks and orders are eventually consistent. \\\nThis operation gets the current global state of projections.\n","operationId":"GetTrackingStatus","responses":{"200":{"description":"The tracking status informations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/trackingStatus"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the global synchronization status of clicks and orders","tags":["Analytics - Tracking"]}},"/user/analytics/{storeId}":{"get":{"operationId":"AnalyticsStoreIndex","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"responses":{"200":{"description":"Analytics API operation index for one store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/analyticsStoreIndex"}}}},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the Analytics API operation index for one store","tags":["Analytics - Global"]}},"/user/analytics/{storeId}/optimisations/all/{actionName}":{"post":{"description":"/!\\ WARNING /!\\ \\\nApply the operation on every product related to this request. \\\nThis operation is used at the bottom of the analytics page result.\n","operationId":"OptimiseAll","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"$ref":"#/components/parameters/optimisationActionNameGeneralParameters"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/optimiseAllRequest"}}},"required":true},"responses":{"204":{"description":"Products optimisatized"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Optimise all products","tags":["Analytics - Optimisations"]}},"/user/analytics/{storeId}/optimisations/bycategory/{catalogCategoryId}/{actionName}":{"post":{"description":"/!\\ WARNING /!\\ \\\nThis operation will reenable or disable products's category for every channel indicated in the body.\n","operationId":"OptimiseByCategory","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"description":"The category identifier concerned by this optimisation","in":"path","name":"catalogCategoryId","required":true,"schema":{"type":"string","format":"guid"}},{"$ref":"#/components/parameters/optimisationActionNameGeneralParameters"}],"requestBody":{"$ref":"#/components/requestBodies/OptimiseByCategoryRequest"},"responses":{"204":{"description":"Products optimisatized"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Optimise products by category","tags":["Analytics - Optimisations"]}},"/user/analytics/{storeId}/optimisations/bychannel/{channelId}/{actionName}":{"post":{"description":"/!\\ WARNING /!\\ \\\nApply the operation on every product on this channel.\n","operationId":"OptimiseByChannel","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"description":"The channel identifier concerned by this optimisation","in":"path","name":"channelId","required":true,"schema":{"type":"string","format":"guid"}},{"$ref":"#/components/parameters/optimisationActionNameGeneralParameters"}],"responses":{"204":{"description":"Products optimisatized"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Optimise products by channel","tags":["Analytics - Optimisations"]}},"/user/analytics/{storeId}/optimisations/byproduct/{productId}/{actionName}":{"post":{"description":"/!\\ WARNING /!\\ \\\nThis operation will reenable or disable this product for every channel indicated in the body.\n","operationId":"OptimiseByProduct","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"description":"The product identifier concerned by this optimisation","in":"path","name":"productId","required":true,"schema":{"type":"string","format":"guid"}},{"$ref":"#/components/parameters/optimisationActionNameGeneralParameters"}],"requestBody":{"$ref":"#/components/requestBodies/OptimiseByCategoryRequest"},"responses":{"204":{"description":"Product(s) optimisatized"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Optimise product","tags":["Analytics - Optimisations"]}},"/user/analytics/{storeId}/optimisations/copy":{"post":{"operationId":"CopyOptimisation","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/copyOptimisationRequest"}}},"required":true},"responses":{"200":{"description":"Products optimisatisation copied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/copyOptimisationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequestResponse"},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Copy product optimisations between 2 channels","tags":["Analytics - Optimisations"]}},"/user/analytics/{storeId}/optimisations/{actionName}":{"post":{"description":"/!\\ WARNING /!\\ \\\nApply the operation on every product related to this request. \\\nThis operation is used at the bottom of the analytics page result.\n","operationId":"Optimise","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"$ref":"#/components/parameters/optimisationActionNameGeneralParameters"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/optimiseRequest"}}},"required":true},"responses":{"204":{"description":"Products optimisatized"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Optimise products by page","tags":["Analytics - Optimisations"]}},"/user/analytics/{storeId}/reports/bycategory":{"post":{"description":"Get the report by category","operationId":"GetStoreReportByCategory","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportByCategoryRequest"}}},"required":true},"responses":{"200":{"description":"Your reporting by channel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportByCategoryResponse"}}}},"400":{"$ref":"#/components/responses/BadRequestResponse"},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the report by category","tags":["Analytics - Statistics"]}},"/user/analytics/{storeId}/reports/bychannel":{"post":{"description":"Get the report by channel","operationId":"GetStoreReportByChannel","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportByChannelRequest"}}},"required":true},"responses":{"200":{"description":"Your reporting by channel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportByChannelResponse"}}}},"400":{"$ref":"#/components/responses/BadRequestResponse"},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the report by channel","tags":["Analytics - Statistics"]}},"/user/analytics/{storeId}/reports/byday":{"post":{"description":"Get the report by day","operationId":"GetStoreReportByDay","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportByDayRequest"}}},"required":true},"responses":{"200":{"description":"Your reporting by day","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportByDayResponse"}}}},"400":{"$ref":"#/components/responses/BadRequestResponse"},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the report by day","tags":["Analytics - Statistics"]}},"/user/analytics/{storeId}/reports/byproduct":{"post":{"description":"Get the report by product","operationId":"GetStoreReportByProduct","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportByProductRequest"}}},"required":true},"responses":{"200":{"description":"Your reporting by product","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportByProductResponse"}}}},"400":{"$ref":"#/components/responses/BadRequestResponse"},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the report by product","tags":["Analytics - Statistics"]}},"/user/analytics/{storeId}/reports/filters":{"get":{"operationId":"GetReportFilters","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"responses":{"200":{"description":"Report filter list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportFilterList"}}}},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get report filter list for the given store","tags":["Analytics - Reports"]}},"/user/analytics/{storeId}/reports/filters/{reportFilterId}":{"delete":{"operationId":"DeleteReportFilter","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"$ref":"#/components/parameters/reportFilterIdOnlyGeneralParameters"}],"responses":{"204":{"description":"Report filter deleted"},"401":{"description":"This report filter is used by rule. In the error message you will find the rule identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"404":{"description":"Report filter not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Delete the report filter","tags":["Analytics - Reports"]},"get":{"operationId":"GetReportFilter","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"$ref":"#/components/parameters/reportFilterIdOnlyGeneralParameters"}],"responses":{"200":{"description":"Report filter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportFilter"}}}},"404":{"description":"Report filter not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the report filter description","tags":["Analytics - Reports"]},"put":{"operationId":"SaveReportFilter","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"$ref":"#/components/parameters/reportFilterIdOnlyGeneralParameters"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/saveReportFilterRequest"}}},"required":true},"responses":{"204":{"description":"Report filter saved"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"description":"This report filter is used by rule. In the error message you will find the rule identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"403":{"description":"This report filter identifier is already used by another store, please check your identifiers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"409":{"description":"Report filter name already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Save the report filter","tags":["Analytics - Reports"]}},"/user/analytics/{storeId}/rules":{"get":{"operationId":"GetRules","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"responses":{"200":{"description":"Rule list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleList"}}}},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Gets the list of rules for a given store","tags":["Analytics - Rules"]},"post":{"operationId":"CreateRule","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createRuleRequest"}}},"required":true},"responses":{"204":{"description":"Rule created"},"400":{"description":"Period on filter cannot be custom or filter does not exist","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"401":{"description":"Store not allowed to use rules. Please upgrade your offer or contact us.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"403":{"description":"Reached the maximum amount of rules allowed for your offer. Please upgrade your offer or contact us.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Rule creation","tags":["Analytics - Rules"]}},"/user/analytics/{storeId}/rules/executions":{"get":{"operationId":"GetRulesExecutions","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"description":"The page to retrieve","in":"query","name":"pageNumber","required":true,"schema":{"type":"integer","minimum":1,"default":1}},{"description":"The count of rule history to retrieve","in":"query","name":"pageSize","required":true,"schema":{"type":"integer","minimum":10,"maximum":100,"default":10}}],"responses":{"200":{"description":"Rules executions list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleExecutionReportings"}}}},"400":{"$ref":"#/components/responses/BadRequestResponse"},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the rules execution history","tags":["Analytics - Rules"]}},"/user/analytics/{storeId}/rules/run":{"post":{"operationId":"RunRules","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"responses":{"204":{"description":"All rules executed."},"401":{"description":"Store not allowed to use rules. Please upgrade your offer or contact us.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"404":{"description":"Rule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"409":{"description":"Rules for this store are currently running. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Run all rules for this store","tags":["Analytics - Rules"]}},"/user/analytics/{storeId}/rules/{ruleId}":{"delete":{"operationId":"DeleteRule","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"$ref":"#/components/parameters/ruleIdOnlyGeneralParameters"}],"responses":{"204":{"description":"Rule deleted"},"404":{"description":"Rule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"409":{"description":"Rules for this store are currently running. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Delete Rule","tags":["Analytics - Rules"]},"get":{"operationId":"GetRule","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"$ref":"#/components/parameters/ruleIdOnlyGeneralParameters"}],"responses":{"200":{"description":"Get Rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule"}}}},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Gets the rule","tags":["Analytics - Rules"]},"patch":{"operationId":"UpdateRule","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"$ref":"#/components/parameters/ruleIdOnlyGeneralParameters"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/updateRuleRequest"}}},"required":true},"responses":{"204":{"description":"Rule updated"},"400":{"description":"Filter does not exist or period on filter cannot be custom","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"401":{"description":"Store not allowed to use rules. Please upgrade your offer or contact us.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"404":{"description":"Rule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"409":{"description":"Rules for this store are currently running. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Update Rule","tags":["Analytics - Rules"]}},"/user/analytics/{storeId}/rules/{ruleId}/disable":{"post":{"operationId":"DisableRule","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"$ref":"#/components/parameters/ruleIdOnlyGeneralParameters"}],"responses":{"204":{"description":"Rule disabled"},"404":{"description":"Rule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"409":{"description":"Rules for this store are currently running. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Disable rule","tags":["Analytics - Rules"]}},"/user/analytics/{storeId}/rules/{ruleId}/enable":{"post":{"operationId":"EnableRule","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"$ref":"#/components/parameters/ruleIdOnlyGeneralParameters"}],"responses":{"204":{"description":"Rune enabled"},"404":{"description":"Rule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"409":{"description":"Rules for this store are currently running. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Enable rule","tags":["Analytics - Rules"]}},"/user/analytics/{storeId}/rules/{ruleId}/movedown":{"post":{"operationId":"MoveDownRule","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"$ref":"#/components/parameters/ruleIdOnlyGeneralParameters"}],"responses":{"204":{"description":"Rule moved down"},"400":{"description":"Priority can only be changed when more than one rule is defined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"404":{"description":"Rule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"409":{"description":"Rules for this store are currently running. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Move the rule down","tags":["Analytics - Rules"]}},"/user/analytics/{storeId}/rules/{ruleId}/moveup":{"post":{"operationId":"MoveUpRule","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"$ref":"#/components/parameters/ruleIdOnlyGeneralParameters"}],"responses":{"204":{"description":"Rule moved up"},"400":{"description":"Priority can only be changed when more than one rule is defined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"404":{"description":"Rule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"409":{"description":"Rules for this store are currently running. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Move the rule up","tags":["Analytics - Rules"]}},"/user/analytics/{storeId}/rules/{ruleId}/run":{"post":{"operationId":"RunRule","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"$ref":"#/components/parameters/ruleIdOnlyGeneralParameters"}],"responses":{"204":{"description":"Rule executed"},"400":{"description":"Rule is not enabled. Please enable this run before trying to run it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"401":{"description":"Store not allowed to use rules. Please upgrade your offer or contact us.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"404":{"description":"Rule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"409":{"description":"Rules for this store are currently running. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Run rule","tags":["Analytics - Rules"]}},"/user/analytics/{storeId}/tracking/clicks":{"get":{"operationId":"GetStoreTrackedClicks","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"description":"The amount of clicks to retrieve","in":"query","name":"count","required":false,"schema":{"type":"integer","minimum":5,"maximum":100,"default":100}}],"responses":{"200":{"description":"Click list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/trackedClicks"}}}},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the latest tracked clicks","tags":["Analytics - Tracking"]}},"/user/analytics/{storeId}/tracking/externalorders":{"get":{"operationId":"GetStoreTrackedExternalOrders","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"description":"The amount of external orders to retrieve","in":"query","name":"count","required":false,"schema":{"type":"integer","minimum":5,"maximum":100,"default":100}}],"responses":{"200":{"description":"External Order list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/trackedExternalOrders"}}}},"400":{"$ref":"#/components/responses/BadRequestResponse"},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the latest tracked external orders","tags":["Analytics - Tracking"]}},"/user/analytics/{storeId}/tracking/orders":{"get":{"operationId":"GetStoreTrackedOrders","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"},{"description":"The amount of orders to retrieve","in":"query","name":"count","required":false,"schema":{"type":"integer","minimum":5,"maximum":100,"default":100}}],"responses":{"200":{"description":"Order list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/trackedOrders"}}}},"400":{"$ref":"#/components/responses/BadRequestResponse"},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the latest tracked orders","tags":["Analytics - Tracking"]}},"/user/analytics/{storeId}/tracking/status":{"get":{"description":"Clicks and orders are eventually consistent. \\\nThis operation gets the current state of projections for a store.\n","operationId":"GetStoreTrackingStatus","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"responses":{"200":{"description":"Store Tracking Status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/storeTrackingStatus"}}}},"404":{"$ref":"#/components/responses/StoreNotFoundResponse"},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the synchronization status of clicks and orders of a store","tags":["Analytics - Tracking"]}},"/user/catalogs/":{"get":{"description":"The operation will give you all the operations you will be able to do and all the LOV used in this API.","operationId":"CatalogIndex","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/catalogIndex"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the index of the catalog API","tags":["Catalogs - Global"]}},"/user/catalogs/beezupColumns":{"get":{"description":"Get the BeezUP columns, this columns are used for mapping during the manual catalog importation process.","operationId":"Catalog_GetBeezUPColumns","responses":{"200":{"description":"The catalog API index","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/beezUPColumnConfiguration"},"type":"array"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the BeezUP columns","tags":["Catalogs - Global"]}},"/user/catalogs/{storeId}":{"get":{"description":"The operation will give you all the operations you will be able to do on this store for this API.","operationId":"CatalogStoreIndex","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"responses":{"200":{"description":"The catalog index","content":{"application/json":{"schema":{"$ref":"#/components/schemas/catalogStoreIndex"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the index of the catalog API for this store","tags":["Catalogs - Catalog"]}},"/user/catalogs/{storeId}/autoImport":{"delete":{"operationId":"Auto_DeleteAutoImport","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"responses":{"204":{"description":"Auto import deleted"},"400":{"description":"Occurs when the catalog auto import is not configured.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"404":{"description":"Occurs when a user tries to work on the wrong store.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Delete Auto Import","tags":["Catalogs - Auto"]},"get":{"operationId":"Auto_GetAutoImportConfiguration","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"responses":{"200":{"description":"Auto import configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/autoImportConfiguration"}}}},"404":{"description":"StoreId or Auto Import configuration not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Get the auto import configuration","tags":["Catalogs - Auto"]}},"/user/catalogs/{storeId}/autoImport/activate":{"post":{"description":"Once you have made your fist manual catalog importation with success, you can call this operation to import it automatically. No parameter required, we know which one it is.","operationId":"Importation_ActivateAutoImport","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"responses":{"204":{"description":"Auto import activated"},"400":{"description":"Occurs when the user tries to auto import a local file.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"404":{"description":"Occurs when a user tries to work on the wrong store.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"409":{"description":"When a catalog importation is already in progress!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Activate the auto importation of the last successful manual catalog importation.","tags":["Catalogs - Auto"]}},"/user/catalogs/{storeId}/autoImport/pause":{"post":{"operationId":"Auto_PauseAutoImport","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"responses":{"204":{"description":"Auto import paused"},"400":{"description":"Occurs when the catalog auto import is not configured.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"404":{"description":"Occurs when a user tries to work on the wrong store.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Pause Auto Import","tags":["Catalogs - Auto"]}},"/user/catalogs/{storeId}/autoImport/resume":{"post":{"operationId":"Auto_ResumeAutoImport","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"responses":{"204":{"description":"Auto import resumed"},"400":{"description":"Occurs when the catalog auto import is not configured.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"404":{"description":"Occurs when a user tries to work on the wrong store.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Resume Auto Import","tags":["Catalogs - Auto"]}},"/user/catalogs/{storeId}/autoImport/scheduling/interval":{"post":{"operationId":"Auto_ConfigureAutoImportInterval","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/configureAutoImportIntervalRequest"}}},"required":true},"responses":{"204":{"description":"Auto import scheduling interval saved"},"400":{"description":"\nWhen the min catalog Auto Import scheduling interval delay has been reached.\nWhen the max catalog Auto Import count has been reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"404":{"description":"Occurs when a user tries to work on the wrong store.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"default":{"$ref":"#/components/responses/GeneralError"}},"security":[{"api_key":[]}],"summary":"Configure Auto Import Interval","tags":["Catalogs - Auto"]}},"/user/catalogs/{storeId}/autoImport/scheduling/schedules":{"post":{"operationId":"Auto_ScheduleAutoImport","parameters":[{"$ref":"#/components/parameters/storeIdOnlyGeneralParameters"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduleAutoImportRequest"}}},"required":true},"responses":{"204":{"description":"Auto import scheduling saved"},"400":{"description":"\nWhen the max catalog Auto Import count has been reached.\nWhen the min catalog Auto Import scheduling interval delay has been reached.\nWhen the max catalog Auto Import count has been reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeezUP.Common.ErrorResponseMessage"}}}},"404":{"description":"Occurs when a user tries to work on the wrong store.","co